Skip to content

Latest commit

 

History

History
24 lines (18 loc) · 709 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (18 loc) · 709 Bytes

Contributing

To create a development environment and install the development dependencies, run :

python3 -m venv venv
. venv/bin/activate
pip install --upgrade pip setuptools
pip install '.[dev]'
pre-commit install --install-hooks

Then you can make your changes, and commit them with

git commit # Pre-commit hooks should be run, checking your code

Every commit is checked with pre-commit hooks for :

  • style consistency with flake8
  • type safety with mypy
  • test conformance by running tests with pytest
    • You can run pytest from the command line.