- Fork the repository on GitHub
- Clone the forked repository to your local machine
- Make your changes and add tests
- Run the tests
- Run the pre-commit hooks (or install them)
- Commit your changes
- Push your changes to your fork
- Open a pull request
The pre-commit hooks are managed by pre-commit. To install them, run:
To run the hooks on all files, install pre-commit and run:
pre-commit run --all
Or to install the hooks so they run automatically on every commit, run:
pre-commit install
To build the documentation via tox
, install it and run:
tox -e docs-sphinx-latest
The tests are managed by pytest.
They can be run either via creating a virtual environment and running pytest
in it,
or using tox to automatically create the virtual environment and run the tests.
To run the tests via tox
, install it and run:
tox
or run tox -av
to see all available environments, and run a specific one via:
tox -e envname
To run manually in an virtual environment, run:
python -m venv .venv
source .venv/bin/activate
pip install -e ".[testing]"
pytest