Skip to content

Contributing

Setup

  1. Clone the repository
  2. Make sure you have Poetry installed
  3. Install project dependencies with poetry install

Linting

  • Run make format to format the code.
  • Run make lint to lint the code.

If you don't have make installed, take a look at the Makefile and run it's commands manually.

Testing

Run make test to run all tests in your local environment.

Documentation

Preview the documentation website locally by running poetry run mkdocs serve.