Developer guide: Getting started#

Use the standard github workflow.

  1. Fork the repository.

  2. Setup the virtual environment for this project.

  3. Install all the development requirements.

pip install -r dev_requirements.txt
  1. Install git pre-commit hooks.

pre-commit install 
  1. Now you are all set. Go ahead, make your changes, test the features using pytest and commit them.

  2. Create a pull request from your fork

Code formatting.#

We use black to format the code and ruff to linting. The rules and formatting are embedded in the pre-commit hooks. So you do not need to explicitly worry about these but is good to know when you see erros while commiting your code or in the CI.