Add AGENTS.md for AI coding agents#48
Conversation
|
Quick note on how this was verified locally before opening the PR. Spawned a fresh Sonnet coding agent in an isolated worktree with the new AGENTS.md as its only project-side guidance, and gave it a small task: "add a The agent flagged one gap: no explicit worked example for naming boolean CLI flags. Added the |
c-h-david
left a comment
There was a problem hiding this comment.
Following up on our conversation yesterday... Would you consider minimizing duplication with other files and instead pointing to them such that maintenance is eased? I understand this might have an impact on "tokens" so it's worth acknowledging here. Notably, the file TESTING.md has much of the description of linting, formatting and testing. Also pyproj.toml includes important linting and formatting options, so do .pymarkdown.yml and .yamllint.yml. I do really like the CLI formatting standard and I wonder if that could justify a separate file of its own pointed to here. I also like the part on registration of CLIs into pyproj.toml. Actually I feel like the pre-PR checklist, the authoritative sources, and the formatting guidance for program structure are the most important new addition and the rest could be perceived as redundant/duplicate/more-maintenance. Thoughts?
Adds an
AGENTS.mdat the repo root as the agent-facing companion toCONTRIBUTING.mdandNOMENCLATURE.md. It summarizes the nine CI lint gates fromCL.ymlwith the exact commands and the most common pitfalls, ships a copy-pasteable Python file skeleton matching the house style in_rapid2.py, and condenses the naming grammar to a scannable quick reference pointing back toNOMENCLATURE.mdfor the full tables. Goal is that a coding assistant with this file in context produces a PR that passes lint on the first try.Also adds
CLAUDE.mdas a symlink toAGENTS.mdso Claude Code (which readsCLAUDE.md) and other tools (which readAGENTS.md) share one source of truth.Closes #40.