33 lines (23 loc) · 1.33 KB

AI Agent Configuration

Development

Use make imports before committing any change to Go code.
Use make modules after any change to a go.mod.
Run make lint-fix before submitting a pull request.
Run the e2e tests before submitting a pull request.
When possible, try to keep pull requests small and self-contained to make reviews easier.

SDK

Do not update dependencies in sdk/go.mod unless necessary to keep the kcp-operator compiling.
Specifically do not attempt to manually bump the Go version in any go.mod file in this project, instead let go mod tidy take care of that.

Documentation

Lines in Markdown files should not exceed 100 characters (use explicit line breaks).

Testing Instructions

Any change that impacts the reconciled resources (Deployments, Certificates, Secrets, ...) should have an accompanying e2e test.
Use make clean build test-e2e-with-kind for running e2e tests.

Changelogs

When generating a changelog for a new release, group all relevant pull requests based on their kind/... label. Output these groups in descending order of importance.
Only include pull requests in the changelog that have a release-note block in their descriptions on GitHub that is not empty or NONE.
List each pull request in the following form: #<number>: <release note> (by @<author>)