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

The documentation site is built with gohan (a static site generator written in Go) and the sleyt CSS theme. From the docs/ directory:

# Install the gohan CLI once
go install github.com/bmf-san/gohan/cmd/gohan@latest

# Install the sleyt CSS dependency
npm install

# Build the CSS and serve with live reload
npm run serve

Then open http://127.0.0.1:1313.

To produce a one-off static build into docs/public/:

npm run build