CONTRIBUTING.md

How to contribute

Dependencies

We use poetry to manage the dependencies.

To install them you would need to run install command:

poetry install

To activate your virtualenv run poetry shell.

One magic command

Run make test to run everything we have!

Tests

We use pytest and ruff for quality control.

To run all tests:

make unit

To run linting:

make format

These steps are mandatory during the CI.

Type checks

We use mypy to run type checks on our code. To use it:

make lint

This step is mandatory during the CI.