CONTRIBUTING.md

Contributing

Before getting started, install Poetry.

Getting Started

To install the project:

poetry install

Optionally, you can also install pre-commit hooks:

poetry run pre-commit install

Lastly, to see common tasks with taskipy:

poetry run task --list

Linting

To ensure code quality, we use the following tools:

• Formatting: black and isort
• Linting: flake8
• Type checking: mypy

To run these:

poetry run task lint

Testing

To run tests via pytest:

poetry run test

Releasing

Releasing is fully automated via our CI pipeline. On each commit to main, it will:

1. Lint and test the codebase
2. Determine if a new version should be released (using conventional commits)
3. If so, bump the version and publish a new release

To override this behavior, include [cd skip] in your commit message.