-
Notifications
You must be signed in to change notification settings - Fork 2.8k
add AGENTS.md to test-infra repo #35820
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: master
Are you sure you want to change the base?
Conversation
BenTheElder
left a comment
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.
I worry about having yet another set of disjoint docs to maintain, can we just tell it to read the README and the Makefile and add any missing details to those?
I think there's way too much info in here that will fall out of date as people that don't use these tools iterate on the makefiles etc.
Can we keep this to info that doesn't make sense for README.md, Makefile help text, developers docs, etc, IE acutal agent-specific instructions? (Such as pointing it to read in those files?)
SergeyKanzhelev
left a comment
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.
lgtm with @BenTheElder 's comments.
I found it best to start with some agents.md and then iterate on it. I wonder if we should place AGENTS_IMPLEMENTATION.md in some subfolders with AGENTS.md linnking it, so we can add more owners for it.
AGENTS.md
Outdated
| - **Postsubmits**: Run after code is merged | ||
| - **Periodics**: Run on a schedule | ||
|
|
||
| ### Adding or Updating Jobs |
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.
I wonder how much we will need to keep this section in root vs. inside the config/jobs/
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.
Yea I think a sub agents folder for config/jobs (espeically sig-node) could be helpful.
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.
/lgtm
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: kannon92 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 |
|
@BenTheElder I updated this to tell agents file to read README.md and contributor guides as much as possible. PTAL. |
Adding agents.md to test-infra repo.
This gives context to AI assistants and helps guide how to develop in this repo.
I generated this with
claude initand moved that generated file to AGENTS.md.Gemini and Claude are able to read the canoical AGENTS.md file with the @AGENTS.md.
I've added this into kueue and jobset.