Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (20 loc) · 899 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (20 loc) · 899 Bytes
Raw

Contributing

Open an issue before substantial changes so scope and compatibility can be agreed. Security reports must follow SECURITY.md.

Development requires Go 1.26 or newer. Before submitting a pull request, run:

go test -race ./...
go run ./cmd/check-fuzz
go vet ./...
go run ./cmd/check-staticcheck
go run honnef.co/go/tools/cmd/staticcheck@v0.8.1 ./...
go build ./cmd/agent-runtime
go run ./cmd/check-fuzz

The linter and scanner versions are pinned where they are invoked, in .github/workflows/ci.yml, so the command you run locally is the command CI runs. staticcheck.conf records which checks are disabled and why.

Keep the core provider-neutral, add tests for behavior changes, update public documentation and CHANGELOG.md, and avoid introducing dependencies without a clear maintenance and security benefit. Commits should be focused and sign-off is not required.