weir
AGENTS.md18 starsChanged 8 days agoApache-2.0View on GitHub
- These rules bind human and agent contributors alike. - Never use the em dash "—". Use plain dash "-" instead - When writing commit messages, NEVER auto-add your agent name as co-author - Never modify files that are marked as auto-generated, or committed fixtures. Regenerate them from their source instead. CHANGELOG.md is the exception: there is no generator, so it is hand-maintained, and a release that changes behaviour adds its entry in the same commit range. - Never read…
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 31,700 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 repositoryOne other file it gives its agents.
- CLAUDE.mdCLAUDE.md
The file
Show its rules and text
We split this AGENTS.md into the rules it gives an agent
14 rules. About 0 are common, 13 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈13
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Distinctive: line 5
Never use the em dash "—".
- Distinctive: line 6
When writing commit messages, NEVER auto-add your agent name as co-author
- Distinctive: line 7
Never modify files that are marked as auto-generated, or committed fixtures.
- Very specific: line 11
Never read a user's home configuration, agent data (such as ~/.claude) or any real user data.
- Distinctive: line 15
When making technical decisions, do not give much weight to development cost.
- Distinctive: line 16
Instead, prefer quality, simplicity, robustness, scalability, and long term maintainability.
- Distinctive: line 18
When doing bug fixes, always start with reproducing the bug in an E2E setting as closely aligned with how an end user would experience it …
- Distinctive: line 30
When end-to-end testing a product, be picky about the UI you see and be obsessed with pixel perfection.
- Distinctive: line 31
If something clearly looks off, even if it is not directly related to what you are doing, try to get it fixed along the way.
- Distinctive: line 33
If you see one, even if it is not caused by what you are working on right now, still get it fixed.
- Distinctive: line 62
Keep this file for knowledge useful to almost every future agent session in this project.
- Distinctive: line 63
Do not repeat what the codebase already shows.
- Distinctive: line 64
Prefer rewriting or pruning existing entries over appending new ones.
- Distinctive: line 65
When updating this file, preserve this bar for all agents and keep entries concise.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 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
Weir
global agent instructions
- These rules bind human and agent contributors alike.
- Never use the em dash "—". Use plain dash "-" instead
- When writing commit messages, NEVER auto-add your agent name as co-author
- Never modify files that are marked as auto-generated, or committed fixtures. Regenerate them from their source instead. CHANGELOG.md is the exception: there is no generator, so it is hand-maintained, and a release that changes behaviour adds its entry in the same commit range.
- Never read a user's home configuration, agent data (such as ~/.claude) or
any real user data; use only the repository's fixtures and synthetic data.
.claude/settings.jsonenforces this for Claude Code, and CONTRIBUTING.md ("Agents working in this repository") says what it cannot stop. - When making technical decisions, do not give much weight to development cost. Instead, prefer quality, simplicity, robustness, scalability, and long term maintainability.
- For one-off or infrequent operational work, start with the simplest direct end-to-end path. Do not build wrappers, control planes, policy layers, custom verifiers, or automation unless the direct path exposes a concrete blocker or repeated need that justifies the added machinery.
- When doing bug fixes, always start with reproducing the bug in an E2E setting as closely aligned with how an end user would experience it as possible. This makes sure you find the real problem so your fix will actually solve it.
- Every test that pins a committed fixture must DERIVE its expectation from the
artifact, never restate a literal, and must be demonstrated to fail under at least
one source mutation. A test that asserts the same constant the code sets is not a
test, it is a copy - it passes for exactly as long as the code and the fixture are
wrong together. This rule is not theoretical: the version-diff corpus shipped a
baseline claiming
observations: []while an uncataloged tool sat on the tainted path of every single fixture. All tests were green and all bytes were stable; only running the real taint engine against the committed bytes exposed it. Derive from the artifact (emit the trace, run the pipeline, compare), then break the source on purpose and watch the test fail before you trust it. - When end-to-end testing a product, be picky about the UI you see and be obsessed with pixel perfection. If something clearly looks off, even if it is not directly related to what you are doing, try to get it fixed along the way.
- Apply that same high standard to engineering excellence: lint, test failures, and test flakiness. If you see one, even if it is not caused by what you are working on right now, still get it fixed.
Corpora land with or after the contract that judges them
A fixture is a claim. The thing that judges it - spec text, a validator, or the consumer it exercises - is that claim's test. A corpus committed before its judging contract exists is a set of expectations nothing can falsify: it freezes, work builds on it, and its errors surface only when the contract finally lands, at which point the fixtures are load-bearing and expensive to move.
Rule: before authoring fixtures, name the contract that judges them. If it exists, cite it and derive expectations from it. If it does not, either write the contract first or defer the corpus - and record the deferral with a named landing site: the milestone whose first mandated action writes that contract.
Worked example: M3 deferred the corrupt OTLP corpus to M4 because the reject-vs-degrade line is the adapter's contract to define and no text drew it yet. Authoring those fixtures in M3 would have committed expectations no code or spec could validate - the same shape as the diffspec observations lie, which every test passed and only a real engine run caught.
Siblings: the derived-tests rule says HOW a fixture is validated (derive from the artifact, prove by mutation). The producer-assertion rule says WHO may assert (telemetry meta-claims are input, never trusted). This rule says WHEN a fixture may exist at all.
Maintaining this file
Keep this file for knowledge useful to almost every future agent session in this project. Do not repeat what the codebase already shows; point to the authoritative file or command instead. Prefer rewriting or pruning existing entries over appending new ones. When updating this file, preserve this bar for all agents and keep entries concise.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
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.

