Skip to content

How to contribute

Contributions to either the code, localization, or the documentation are very welcome!

Development task runner

We use just to execute common tasks. It is available for any platform. Once installed, you can see a list of available commands by running just --list.

Dependencies

We use uv to manage the Python dependencies. If you don't have uv, you should install with just uv-install.

To install dependencies and prepare pre-commit hooks you would need to run the setup command:

just bootstrap

Running updates

After pulling new updates from the repository you can quickly install updated dependencies and run database migrations by running just bootstrap.

Codestyle

After installation you may execute code formatting.

just fmt

Checks

Many checks are configured for this project.

To run your test suite:

just test

Or you can run testing for linting and multiple supported Python versions via:

just tox

To use pyright for type checking run: 

just check-types

To run linting:

just check

The just safety command will look at the security of your code.

Before submitting

Before submitting your code please do the following steps:

  1. Add any changes you want
  2. Add tests for the new changes
  3. Edit documentation if you have changed something significant
  4. Run just fmt to format your changes.
  5. Run just check to ensure that types, security and docstrings are okay.
  6. Add your name to the CONTRIBUTERS.txt file.

Other help

You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.