Contributing

Bug reports, feature requests, and pull requests are welcome on GitHub.

Development setup

git clone https://github.com/saemeon/mypackage
cd mypackage
uv sync --group dev

Pre-commit hooks are managed with prek. They run automatically on git commit once you have installed the dev dependencies.

uv run ruff check .
uv run ruff format --check .
uv run ty check
uv run pytest

uv sync --group doc
uv run mkdocs serve