From ad4c6107fedef52d757ee5d8c0b33a6875f2e56e Mon Sep 17 00:00:00 2001 From: Christoph Mewes Date: Wed, 11 Mar 2026 15:16:20 +0100 Subject: [PATCH] add initial, basic AGENTS.md On-behalf-of: @SAP christoph.mewes@sap.com --- AGENTS.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..6c2feb5 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,32 @@ +# AI Agent Configuration + +## Development + +* Use `make imports` before committing any change to Go code. +* Use `go mod tidy` after any change to a `go.mod`. +* 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: `#: (by @)"