Skip to content

Contributing

We love contributions! See the canonical CONTRIBUTING.md in the repository for the full guide. In short:

  1. Fork and clone the repo.
  2. make test before you push.
  3. Follow Conventional Commits for commit messages and PR titles — the CI enforces it.
  4. Every third-party GitHub Action must be pinned to a full commit SHA with a trailing # vX.Y.Z comment, per OSSF Scorecard.

Building the docs site locally

pip install mkdocs-material
mkdocs serve

Then open http://127.0.0.1:8000.