Contributing¶
Setting up¶
Using a Dev Container (recommended)¶
Open the project in the provided development container to get all tools and dependencies up and running automatically.
If it is your first time using a dev container, you can follow this guide to set it up.
Manual installation¶
See this page to install poetry if you don’t have it already.
All the commands that you may use are grouped in the root Makefile. So make sure that you have Make available in your environment, otherwise you can just copy the commands from the Makefile and paste them in your terminal.
In order to install the project and required dependencies, you can run make setup.
Testing¶
Running tests¶
Tests can be run with pytest using make test.
Some tests are marked as slow. By default they are not executed.
you can run them using make test-runslow.
Test coverage¶
You can check your test coverage locally by using the
coverage
package through make coverage.
All the tests will be run, including the slow ones.
An HTML report will be generated in the htmlcov directory
at the root of the project, highlighting which lines
of code were not covered by the tests.
Linting and code formatting¶
Ruff is used for linting and formatting our code.
It can be run using the make lint and make format commands.
These two actions will also be run every time you commit changes, by the pre-commit hook. The commit will fail after the files are changed by ruff, so that you can take a look and stage these changes before validating.
Type checking¶
This project ensures strict type checking using mypy.
In order to check whether your changes are correctly typed,
you can run make type-check.
Documentation¶
All user-exposed classes, methods and functions you add must be documented, following the Google style guide.
The documentation is built using Sphinx.
You can generate it locally using make docs.