Repository navigation
Contributing
Susant Sahani edited this page Oct 18, 2026
·
1 revision
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 NodeRules:
- Keep provider-specific behavior behind
internal/provider.Provider. - Do not expose raw provider identifiers as the primary public machine ID.
- Add tests for lifecycle and error paths.
- Run
make checkbefore a PR; CI also runs golangci-lint, govulncheck and gosec. - No Microsoft media, keys or activation bypasses.
- Update README/docs when adding API fields, providers or config.
- New files need the Apache-2.0 header (
./scripts/add-license-headers.sh). - 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).
Kryton v1.3.0 - Apache-2.0 - Repository - Repo docs are authoritative.