How to Contribute?

Guidelines

The project dependencies are managed using uv, see their installation guide. For even more stability, I recommend using pyenv or python 3.9.16.

Additionally, to make your life easier, install make to use the shortcut commands.

To install the dependencies:

uv sync

Before committing, install pre-commit:

uv run pre-commit install

To run the checks (pre-commit checks):

make checks

To run the tests (using pytest):

make tests

Make a branch before making a pull request to develop.