Contributing
statio is open source. The canonical guide lives in
CONTRIBUTING.md; the
essentials are below.
Build & test
Section titled “Build & test”git clone https://github.com/accentiostudios/statiocd statiogo build ./...
# the same checks CI runs — all must be green:go vet ./...go test ./...gofmt -l . # must not list any fileYou’ll want Go (the version is pinned in go.mod), Docker to test the agent, and optionally a
Tailscale account for end-to-end testing.
- Standard Go, formatted with
gofmt. Avoid new dependencies unless necessary. - Comments and documentation in English.
- Commit messages in English, Conventional Commits
(
feat:,fix:,docs:…, with an optional scope).
Security
Section titled “Security”If your change touches verification, payload parsing, compose generation or secret handling, explain in the PR how it preserves the invariants in the security model. Found a vulnerability? Don’t open a public issue — use GitHub’s private reporting (Security → Report a vulnerability).
Releases (maintainers)
Section titled “Releases (maintainers)”Releases are cut with a tag; GoReleaser builds and signs the binaries and publishes the GitHub
Release, and the moving v1 tag is repointed so uses: accentiostudios/statio@v1 tracks the latest.
git tag vX.Y.Zgit push origin vX.Y.ZThe documentation site (this site) is published by .github/workflows/docs.yml on every push to
main that touches website/.