Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.03 KB

Contributing

Thanks for helping improve Kontext CLI.

Ground rules

  • Keep changes small, direct, and production-ready.
  • Use conventional commits. Release automation depends on them.
  • Do not add compatibility shims unless they are required for a safe production migration.
  • Prefer the standard library and existing dependencies over new packages.

Local setup

go mod download
go test ./...
go test -race ./...
go vet ./...
gofmt -w ./cmd ./internal

If you touch generated protobuf code, also run:

buf generate

Pull requests

  • Include tests for behavior changes.
  • Update the README when user-facing behavior changes.
  • Keep generated code, docs, and release notes in sync with the code.
  • Public PRs also run dependency-review, so dependency changes must pass both CI and GitHub advisory checks.

Release flow

  • release-please opens release PRs and calculates semver bumps from conventional commits.
  • GitHub Releases are built with GoReleaser.
  • Homebrew publishing is handled from the release workflow.