Contributing 🌳

Prerequisites

make
node (required for pyright)
python >= 3.9

Getting started

make install creates the dev environment with:

a virtualenv in .venv/
pyright in node_modules/
git hooks for formatting & linting on git push

. .venv/bin/activate activates the virtualenv.

The make targets will update the virtualenv when pyproject.toml changes.

Usage

Run make to see the options for running tests, linting, formatting etc.

PRs

Use conventional commit types in the PR title. These are used to label the PR and categorise the release notes.

Release

The Release Drafter workflow will automatically create and update a draft release whenever a PR is merged.

To release:

visit the release page and edit the pre-prepared draft release
check the tag version number and release notes are good to go
click Publish release. This will
- tag the commit
- trigger the CI workflow to publish the package to PyPI.