Contributor guidelines¶
Developer prerequisites¶
pre-commit¶
Refer to pre-commit for installation instructions.
TL;DR:
pip install pipx --user # Install pipx
pipx install pre-commit # Install pre-commit
pre-commit install # Install pre-commit hooks
Installing pre-commit will ensure you adhere to the project code quality standards.
Code standards¶
black, isort, ruff and doc8 will be automatically triggered by pre-commit. Still, if you want to run checks manually:
./scripts/black.sh
./scripts/doc8.sh
./scripts/isort.sh
./scripts/ruff.sh
Virtual environment¶
You are advised to work in virtual environment.
TL;DR:
python -m venv env
pip install -e .
pip install -r requirements/test.txt
Documentation¶
Check documentation.
Testing¶
Check testing.
If you introduce changes or fixes, make sure to test them locally using all supported environments. For that use tox.
tox
In any case, GitHub Actions will catch potential errors, but using tox speeds things up.
Pull requests¶
You can contribute to the project by making a pull request.
For example:
- To fix documentation typos.
- To improve documentation (for instance, to add new recipe or fix an existing recipe that doesn’t seem to work).
- To improve performance.
- To introduce a new feature.
General list to go through:
- Does your change require documentation update?
- Does your change require update to tests?
- Does your change rely on third-party cloud based service? If so, please
make sure it’s added to tests that should be retried a couple of times.
Example:
@pytest.mark.flaky(reruns=5).
When fixing bugs (in addition to the general list):
- Make sure to add regression tests.
When adding a new feature (in addition to the general list):
- Check the licenses of added dependencies carefully and make sure to list them in prerequisites.
- Make sure to update the documentation (check whether the installation, usage examples and prerequisites require changes).
Questions¶
Questions can be asked on GitHub discussions.