Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 701 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 701 Bytes

Contributing

Project Setup

Configure your virtual environment of choice with Python 3.8 through 3.11. Python 3.9 is recommended.

Install pip requirements and local code with:

pip install -r requirements.txt -r requirements-dev.txt
pip install -e .

Run pre-commit install to enable the pre-commit configuration:

pre-commit install

The pre-commit hooks will be run against all files during a git commit, or you can run it explicitly with:

pre-commit run --all-files

If for some reason, you wish to commit code that does not pass the precommit checks, this can be done with:

git commit -m "message" --no-verify