🌱 Add Agents.MD with an alias for .github/.instructions.md to support AI tools #5152
Conversation
k8s-ci-robot
added
cncf-cla: yes
k8s-ci-robot
added
the
approved
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive AGENTS.md documentation file for the Kubebuilder project, providing guidance for automation agents and developers working with the framework.
Key changes:
- New AGENTS.md file documenting Kubebuilder's architecture, components, and development workflow
- Includes detailed sections on build/test commands, repository layout, and code style guidelines
- Provides automation agent-specific instructions for running E2E tests
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Nice! Finally we have a standard! LGTM!
Just two suggestions:
Since agents are being delegated to run tasks in the background and are able to create PRs, perhaps we should include the PR guidelines as well.
Also, one common problem I have seen with agents is that they usually reinvent the wheel for things that are already present in the codebase, so it could be useful to give directives on how to take advantage of the utilities commonly used in the project.
WDYT?
camilamacedo86
force-pushed
the
add-agents.md
branch
from
f038b60 to
e0e70af
Compare
|
Thank you for the review. I think it is good enough to fly now :-) |
|
/override pull-kubebuilder-e2e-k8s-1-34-0 |
|
@camilamacedo86: Overrode contexts on behalf of camilamacedo86: pull-kubebuilder-e2e-k8s-1-34-0 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, vitorfloriano The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
camilamacedo86
changed the title
k8s-ci-robot
added
the
do-not-merge/work-in-progress
camilamacedo86
force-pushed
the
add-agents.md
branch
from
e0e70af to
055fdbe
Compare
camilamacedo86
changed the title
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
camilamacedo86
force-pushed
the
add-agents.md
branch
from
055fdbe to
64ef3ae
Compare
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
camilamacedo86
force-pushed
the
add-agents.md
branch
from
64ef3ae to
d498ede
Compare
camilamacedo86
changed the title
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
.github/copilot-instructions.md:1
- The file contains only a relative path reference '../AGENTS.md' rather than actual content or a proper symlink. If the intention is to reference the AGENTS.md file, consider using a symlink or include explanatory text indicating this is a reference file. Most Markdown renderers will not automatically resolve this path reference.
# Kubebuilder AI Agent Guide
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
camilamacedo86
force-pushed
the
add-agents.md
branch
from
d498ede to
f5503f3
Compare
camilamacedo86
force-pushed
the
add-agents.md
branch
from
f5503f3 to
a14c8b4
Compare
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
camilamacedo86
force-pushed
the
add-agents.md
branch
from
a14c8b4 to
93bc4d9
Compare
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
camilamacedo86
force-pushed
the
add-agents.md
branch
from
93bc4d9 to
9249a8e
Compare
camilamacedo86
changed the title
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
.github/.instructions.md:1
- The file appears to contain only a relative path reference '../AGENTS.md' without any context. If this is intended to be a symlink or reference file, consider adding a markdown link or explanation. For example:
See [AGENTS.md](../AGENTS.md) for AI agent guidelines.
# Kubebuilder AI Agent Guide
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
camilamacedo86
force-pushed
the
add-agents.md
branch
from
9249a8e to
352894e
Compare
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
camilamacedo86
force-pushed
the
add-agents.md
branch
from
352894e to
f3d4ca0
Compare
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@vitorfloriano since you LGTM I am moving forward here for our quick start. However, folllow up contributions are very well appreciated always 🎉 |
camilamacedo86
added
the
lgtm
3 participants
See: https://agents.md/
This doc adds the file with the info to be shared with AI tools for context.
Create symbolic link. for .github/,instructions.md (for GitHub/VS Code tools)
c/c @vitorfloriano