Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 696 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 696 Bytes

Contributing

Thank you for contributing! This section describes the typical steps in setting up a development environment.

Setup a virtual environment with uv

uv sync
source venv/bin/activate

Install pre-commit

This will install the pre-commit package and then install the pre-commit hooks for standardized formatting.

uv tool install pre-commit
pre-commit install

Running the tests

From within your virtual environment:

pytest

Contributing

Committing the change will run all necessary formatting, type checking, and linting. Prefer small PRs to make reviews easy to manage.