Skip to main content

Contributing

The full guide is CONTRIBUTING.md. In short:

  • Bugs and features — open an issue with the Bug, Feature or Question template, in the repository whose code is affected. Not sure which? Open it in environments.
  • Larger changes — to a public API, a contract or the delivery model: open an issue to discuss the approach before writing code.
  • Pull requests — branch from develop, add tests, run go build ./... && go vet ./..., gofmt -l ., golangci-lint run and go test ./..., then open the pull request against develop.
  • Commits — use Conventional Commits and sign off each commit (git commit -s) under the Developer Certificate of Origin.
  • Security issues — never in a public issue; see Security.

Contributions are licensed under the Apache License 2.0.