CONTRIBUTING.md

Contributing

Developer Guide

Setup

This project uses hatch to manage the development environment and build and publish releases. Make sure hatch is installed first:

$ pip install hatch

Now you can enter the development environment using:

$ hatch shell

This will install development dependencies in an isolated environment and drop you into a shell (use exit to leave).

Pre-commit

Use pre-commit to run linting, type-checking, and formatting:

$ hatch run pre-commit run --all-files

...or install it to run automatically before every commit with:

$ hatch run pre-commit install

Testing

Unit tests are not run by pre-commit, but can be run manually using hatch scripts:

$ hatch run test:all

Measure test coverage with:

$ hatch run test:coverage