iocraft
AGENTS.md1.6k starsChanged 7 months agoApache-2.0View on GitHub
Read CONTRIBUTING.md before making changes. In particular:
We split this AGENTS.md into the rules it gives an agent
1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 3
Read CONTRIBUTING.md before making changes.
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Guidance for AI agents
Read CONTRIBUTING.md before making changes. In particular:
- Never edit
CHANGELOG.mdfiles. They're generated from commit messages at release time. Manual entries are redundant and cause merge conflicts. - Be very conservative with public doc comments. Most bug fixes need no doc changes. Don't add sentences describing the fix, the absence of the bug, or implementation details (locks, borrows, internal helpers, etc.). Only document behavior that a user of the crate can observe and needs to know about. Put notes for maintainers in regular
//comments, and put summaries of your work in the commit message or pull request description.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository2 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.