Skip to content

Contributing

Susant Sahani edited this page Oct 18, 2026 · 1 revision

Contributing

From CONTRIBUTING.md and the Makefile:

make check      # fmt, test, vet, build, web-check
make test
make race       # go test -race ./...
make vet
make lint       # golangci-lint (CI also runs it)
make vulncheck  # govulncheck
make web        # rebuild the React console into cmd/krytond/web (committed); needs Node

Rules:

  1. Keep provider-specific behavior behind internal/provider.Provider.
  2. Do not expose raw provider identifiers as the primary public machine ID.
  3. Add tests for lifecycle and error paths.
  4. Run make check before a PR; CI also runs golangci-lint, govulncheck and gosec.
  5. No Microsoft media, keys or activation bypasses.
  6. Update README/docs when adding API fields, providers or config.
  7. New files need the Apache-2.0 header (./scripts/add-license-headers.sh).
  8. Add a line under ## [Unreleased] in CHANGELOG.md for user-visible changes (and keep RELEASE_NOTES.md in sync at release).

Contributions are under Apache-2.0. Security reports: SECURITY.md (private GitHub Security Advisories).

Clone this wiki locally