-
Notifications
You must be signed in to change notification settings - Fork 67
🌱 Add AGENTS.md to assist AI agents interacting with this repository #2274
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.
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
base: main
Are you sure you want to change the base?
Conversation
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
@@ -0,0 +1,251 @@ | |||
# AGENTS.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @joelanford
Seems that Copilot accept AGENTS.md -> https://code.visualstudio.com/docs/copilot/customization/custom-instructions
But will that be understood by CLAUD and ANY other possible ones as well?
OH seems like they agreed upon: https://agents.md/
That is amazing !!!!
I researched that 2 months ago, and I could not find a generic/standard one. Things are changing too fast 🚀
|
||
This file provides instructions for autonomous agents working in the operator-controller repository. | ||
|
||
## Repository Context |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But before we add it, what info here is valid only for upstream?
If we add this, will all be valid for downstream? I do not think so,
So, how will we have information for upstream and another for downstream?
@joelanford @tmshort have you ideas?
What about we ignore those files in the sync/bumper?
Do we want to have the same for downstream? Could we have a version there that is not removed by the bumper as well?
@joelanford out of curiosity, how did you instruct Cloude to generate this file? |
Description
In order for maintainers and external developers to have a tailored experience using AI development tools, it is helpful to include an
AGENTS.md
file in the repo to guide AI agents in their tasks.I used Claude Code to generate the
AGENTS.md
file in this PR.Reviewer Checklist