CONTRIBUTING.md

Contributing

We welcome contributions to the project. Please follow the guidelines below.

Development environment

We use pixi to manage the development environment.

pixi install
pixi shell -e dev

Testing

Use pytest to run the unit checks:

pixi run test

Linting

We use ruff to lint the code. Run the following command to check the code:

pixi run lint

Check all files

Recommended before creating a commit: to run all checks against all files, run the following command:

pixi run checkall