How to Contribute?

Guidelines

The project dependencies are managed using uv, see their installation guide.

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

Install the dependencies and the pre-commit hooks:

just install

To ensure CI passes, run the checks and tests. To run the checks (pre-commit checks):

just checks

To run the tests (using pytest):

just tests

Make a branch in your fork before making a pull request to main.

Ideas can be submitted through the GitHub Discussions or via Roadmap Issues.