Skip to content

add initial, basic AGENTS.md #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xrstf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add initial, basic AGENTS.md #177

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# AI Agent Configuration

## Development

* Use `make imports` before committing any change to Go code.
Copy link
Member

@ntnn ntnn Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this should also include make fix-lint. Although it should be fine to do that only after finishing work/before creating a PR.

* 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: `#<number>: <release note> (by @<author>)"
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The inline-code example on this line has mismatched backticks and an extra trailing quote, which breaks Markdown rendering for the rest of the file. Consider changing it to a properly closed inline code span (and remove the trailing ").

Suggested change
* List each pull request in the following form: `#<number>: <release note> (by @<author>)"
* List each pull request in the following form: `#<number>: <release note> (by @<author>)`

Copilot uses AI. Check for mistakes.
Loading