Contributing

To contribute, you can fork us! And open any pull request or tackle any issue in our GitHub repository.

Recommendations

  • Try to be on one of the latest master versions.

  • Try to always put and commit your change sets into a new and meaningful branch in your fork.

  • Update the changelog file with the changes you made.

Code Style

We use Ruff to ensure a consistent code-style and reduce common Python issues in code changes.

You can install a checker by running pre-commit install after installing our development requirements (pip install -e '.[dev]'). After that, you can add your changes through git and run pre-commit to check if your changes are issue-free.

Development & Contribution

The guidelines are available at on GitHub.