Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (29 loc) · 633 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (29 loc) · 633 Bytes

Contributing

Setup

uv sync --all-groups

Run Checks

uv run ruff check .
uv run ruff format --check .
uv run mypy .
uv run pytest -q

Pre-commit

Install hooks:

uv run pre-commit install

Run hooks manually:

uv run pre-commit run --all-files

Release Process

  1. Update version in pyproject.toml (SemVer).
  2. Merge changes to main.
  3. Create and push a matching tag: vX.Y.Z.
  4. GitHub Actions runs .github/workflows/release.yml:
    • validates tag/version match,
    • builds with uv build --no-sources,
    • publishes with PyPI Trusted Publishing (OIDC).