Skip to content

Contributing

For the complete contribution workflow, use the repository-level guide: CONTRIBUTING.md.

Quick Contributor Flow

  1. Open or confirm an issue for non-trivial changes.
  2. Create a focused branch (feat/<short>, fix/<short>, docs/<short>, or chore/<short>).
  3. Run local quality checks:
  4. pre-commit run --all-files
  5. ruff check .
  6. black --check .
  7. pytest -q
  8. Update docs and CHANGELOG.md for user-facing changes.
  9. Open a PR with validation notes.