Skip to content

add initial, basic AGENTS.md#177

Open
xrstf wants to merge 1 commit intokcp-dev:mainfrom
xrstf:agents
Open

add initial, basic AGENTS.md#177
xrstf wants to merge 1 commit intokcp-dev:mainfrom
xrstf:agents

Conversation

@xrstf
Copy link
Contributor

@xrstf xrstf commented Mar 11, 2026

Summary

This is my first attempt at creating and committing a re-usable AI agent config file. It seems that AI usage is inevitable anyway and there are some things I would like to share with everyone else, like how e2e tests should be run.

I tried to follow https://agents.md/.

What Type of PR Is This?

/kind chore

Release Notes

NONE

On-behalf-of: @SAP christoph.mewes@sap.com
@kcp-ci-bot kcp-ci-bot added release-note-none Denotes a PR that doesn't merit a release note. kind/chore Categorizes issue or PR as related to maintenance and other usually non-code changes. dco-signoff: yes Indicates the PR's author has signed the DCO. labels Mar 11, 2026
@kcp-ci-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign scheeles for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kcp-ci-bot kcp-ci-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 11, 2026
@ntnn ntnn requested a review from Copilot March 11, 2026 21:39
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds an initial AGENTS.md file to document shared guidance for AI agents and contributors, focusing on development workflow, SDK dependency handling, documentation conventions, testing, and changelog generation.

Changes:

  • Introduces AGENTS.md with recommended commands and contribution/testing guidelines.
  • Documents rules around SDK go.mod/Go version changes and changelog formatting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

`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.

## Development

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: yes Indicates the PR's author has signed the DCO. kind/chore Categorizes issue or PR as related to maintenance and other usually non-code changes. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants