Conversation
On-behalf-of: @SAP christoph.mewes@sap.com
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
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.mdwith 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>)" |
There was a problem hiding this comment.
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 ").
| * 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>)` |
|
|
||
| ## Development | ||
|
|
||
| * Use `make imports` before committing any change to Go code. |
There was a problem hiding this comment.
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.
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