development.rst

Developers Setup

This section is for developers wanting to contribute to the project.

Setup pre-commit hooks

The project uses pre-commit to run some checks before committing code. Install pre-commit by running the following command:

pip install pre-commit

To setup the pre-commit hooks, run the following command from the root of the project:

pre-commit install

Then every time you commit, pre-commit will run all checks defined in .pre-commit-config.yaml. you can run the pre-commit checks manually by running:

pre-commit run --all-files