Repository navigation
docs: Add AGENTS.md and CLAUDE.md for AI coding agents - #1774
DiamondJoseph wants to merge 1 commit into
Conversation
AGENTS.md gives coding agents what they cannot cheaply work out from the code: the checks CI runs, the files that must change together, the public contracts other teams rely on and what to ask before changing. It also asks agents to disclose their involvement with an Assisted-by footer and to consider variance when using generics. CLAUDE.md only imports AGENTS.md, because Claude Code reads CLAUDE.md. Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com> Assisted-by: Claude Fable 5.2 via Claude Code
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1774 +/- ##
=======================================
Coverage 96.30% 96.30%
=======================================
Files 50 50
Lines 3821 3821
=======================================
Hits 3680 3680
Misses 141 141 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Not going to block this if it something everyone wants but I would just like it on record that I hate everything about it. |
Better to have guardrails now and denote any practices we don't want ridden roughshod over before it happens. Join us Peter. 🤖 . |
ZohebShaikh
left a comment
There was a problem hiding this comment.
I feel like the harness for your personal agent is a personal thing and you should configure it according to your own taste.
If we put this in VCS it needs to be reviewed by human. With no verification system it is very costly in terms of time for reviewers.
My suggestion if this added to VCS
Auto approved and merge is enabled just for this file.
(With a ci verification of prompt injections, etc)
A special agent:(or something else) created to make sure we can filter this out in release notes
The approach I would like.
In your dotfiles configure to ignore the agents file. And then your agent can keep using/changing it as you wills without maintenance overhead on human reviewers
That's against current conventions; there's 1.4M examples on github: https://github.com/search?q=path%3AAGENTS.md+NOT+is%3Afork+NOT+is%3Aarchived&type=code and you can find all manner of resources out there. It's your choice if you're working on a project with just you, but this is a shared project that needs to have shared expectations. It also enables e.g. agentic review in CI (UoC are using Gitlab Duo, don't know if Diamond will ever enable Copilot reviews?) to be a little more thorough.
It's not that long to read it right now and ensure it's correct, then to read any updates- there won't be updates with every change, just whenever the system or expectations or build changes, so it can also act as an early warning. It just puts guardrails up now to make sure AI don't go rogue.
I disagree. Treat it like the readme: make sure any changes are accurate, make sure it is read by any [AI] contributors (NB: this will happen automatically when they read the project into context) the same way you'd direct a human to the readme before they contribute. My org are also using it as a marker that the codebase has been checked for any leaked credentials- it's probably best if no agents are used on a project until it has an agents.md, because that means somebody has at least thought about the risks. |
Adds guidance for AI coding agents working in this repository. There is no linked issue.
What changed
AGENTS.mdfollows the agents.md convention, which most coding agents read. It holds what an agent cannot cheaply work out from the code:justrecipes inside the devcontainer and asuvcommands outside itpytestcollecting the system testsREST_API_VERSIONCLAUDE.mdcontains only@AGENTS.md, because Claude Code readsCLAUDE.mdand this imports the same file.Policy the file sets, for reviewers to agree or change
Assisted-by: <model name> via <tool name>footer on every commit and pull request description, following the Assisted-by footer note.Things to know
is_compatible_argsincore/context.pycompares type arguments withissubclass(actual, expected)whatever variance the protocol declares. For aMovable[int]parameter it accepts aMovable[bool]device and rejects aMovable[object]one, althoughMovableis contravariant. No issue has been filed.developerimage was built to confirm it containsjust,uvandhelmwith the schema plugin.just lintandjust unitwere not run inside the devcontainer, and the system tests were not run.docs/how-to/run-with-dev.mdfor the devcontainer. That page is rewritten in docs: Update docs to match code #1773 and is out of date until that merges.decision pending,needs clarification) will need updating.Instructions to reviewer on how to test:
AGENTS.mdand check that the workflow and policy it describes are what the team wants agents to follow.just lintandjust unitas the Commands section describes.Checks for reviewer
🤖 Generated with Claude Code
Assisted-by: Claude Fable 5.2 via Claude Code