CONTRIBUTING.md

Contributing to MML

First of all: Thank you for your interest in contributing to MML! This document provides guidelines and instructions for contributing to this project. In case you have any questions, do not hesitate to get in touch with the members of the core development team:

Patrick Godau

• Contributing to MML
  • Getting Started
  • Development Process
  • Code Style
  • Testing
  • Pull Request Process
  • License
  • Contribution review and integration
  • List of Contributors

Getting Started

1. Fork the repository
2. Clone your fork
3. Create a virtual environment
4. Install ``mml` in editable mode including the development dependencies:

   pip install -e ".[dev,docs]"

Development Process

1. Open an issue and discuss the strategy on how to tackle it
2. Create a new branch for your feature (feature/) or bugfix (fix/), add the number of the issue (e.g. feature/123)

   git checkout -b feature/123

3. Make your changes, following our coding standards
4. Add tests for any new functionality
5. Run the test suite:

   pytest

6. Update documentation as needed (see docs)
7. Commit your changes:

   git add .
   git commit -m "Description of changes"

Code Style

We follow these coding standards:

• PEP 8 - Python style guide
• type hints for function arguments and return values
• document functions and classes using Sphinx docstrings
• maximum line length of 120 characters (set in pyproject.toml)

We use the following tools for code quality:

• ruff for code formatting
• isort for import sorting
• pylint for overall quality

Run the full suite of checks with:

ruff check
ruff format
isort .
pylint src/mml --max-line-length 120

Testing

Add positive and negative test cases. Mock dependencies appropriately. The mml.testing package provides a set of pytest.fixtures you can leverage even when writing tests for plugins.

Pull Request Process

• update the CHANGELOG.md following Keep a Changelog format
• make sure all tests pass and code quality checks succeed
• check documentation, including docstrings of added / changed classes and functions
• submit a pull request with a clear description of the changes, for this your pull request should:
  • have a clear, descriptive title
  • reference any related issues
  • include a summary of changes
  • note any backward compatibility breaking changes

License

By contributing, you agree that your contributions will be licensed under the project's license (MIT). All added or edited code shall be the own original work of the particular contributor. If you use some third-party implementation, all such blocks/functions/modules shall be properly referred and if possible also agreed by code’s author. For example - "This code is inspired from http://...". In case you are adding new dependencies, make sure that they are compatible with the actual license (i.e. dependencies should be at least as permissive as the MIT license).

Contribution review and integration

To ensure correctness and high quality of the submitted code, each contribution will be checked by the CI pipeline and reviewed by a member of the core development team regarding among others the following aspects:

• The code is correct and implements the described feature / fixes the described issue
• The code follows our coding style
• The code is documented appropriately
• The code is covered by sensible unit tests that pass upon submission
• The contribution does not lead to side effects in other parts of the toolkit (e.g. failing tests) Once the reviewer is content with the contribution, the changes will be integrated into the code base.

List of Contributors

In the following table we list the people that have contributed to the MML toolkit.

Main author (>99%):

• Patrick Godau

Other contributors:

• Akriti Srivastava
• Leon Mayer
• Dominik Michael
• Piotr Kalinowski
• Amine Yamlahi