add AGENTS.md to test-infra repo #35820
Conversation
k8s-ci-robot
added
cncf-cla: yes
BenTheElder
left a comment
BenTheElder
left a comment
There was a problem hiding this comment.
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
SergeyKanzhelev
left a comment
There was a problem hiding this comment.
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.
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.
Yea I think a sub agents folder for config/jobs (espeically sig-node) could be helpful.
k8s-ci-robot
added
the
lgtm
|
@BenTheElder I updated this to tell agents file to read README.md and contributor guides as much as possible. PTAL. |
|
@BenTheElder any chance to merge this? |
BenTheElder
left a comment
BenTheElder
left a comment
There was a problem hiding this comment.
I still dislike the amount of overlap with things that should just be documented for both humans and robots and the need to pollute the repo root with vendor-specific files (we haven't added something like a vscode config to every repo either), but ....
/approve
/hold
cc other current repo OWNERS @dims @michelle192837 @aojea @upodroid
k8s-ci-robot
added
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: BenTheElder, kannon92 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
I don't think so, changing instructions for agents is comparable to changing instructions for human contributors, that should be reviewed by the repo owners in both cases. There's been a parallel set of threads for org spanning policies etc since this was first opened. |
There was a problem hiding this comment.
Can we drop the per provider md file? https://agents.md/ All of them should be able to read AGENTS.md
There was a problem hiding this comment.
Doesn't work that way yet.
There was a problem hiding this comment.
Not sure about gemini but I think its slowing becoming a standard.
There was a problem hiding this comment.
Yeah, I checked again, still not the case.
agents.md is supposed to work like OWNERS with more deeply nested docs, but it's not widely adopted yet.
I would expect agents to widely read README.md eventually as well but ...
gemini can be configured to read other files, but that's opt-in client-side in the user's settings.
5 participants
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.