Contributing#
Developer guide: Getting started#
Use the standard github workflow.
Fork the repository.
Setup the virtual environment for this project.
Install all the development requirements.
pip install -r dev_requirements.txt
Install git pre-commit hooks.
pre-commit install
Now you are all set. Go ahead, make your changes, test the features using
pytest
and commit them.
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.