CONTRIBUTING.md

Contributing

Setting up development environment

This package uses poetry for everything, install it if you don't have it:

pip install poetry

After cloning the repository, run:

poetry install --extras all

This will install all optional and dev dependencies, they're required for development.

Running tests

pytest

Setting up git hooks

We use pre-commit. To install it, run this after activating virtual environment:

pre-commit install

Now before any commit you make, changes will be validated, files reformatted etc.

Setting up type checker

This project uses pyright for type checking. It is an npm package, so if you don't have Node, don't bother installing — you will see issues that come up in continuous integration on PR. If you use VS Code, Pyright is built-in.

To install pyright, run:

npm install -g pyright