agentleFS
owainlewisowainlewis/blueprint/AGENTS.md

blueprint

AGENTS.md423 starsChanged 3 months agoMITView on GitHub

Blueprint is a small set of instructions for AI coding. Blueprint skills are opt-in workflows. Use them only when explicitly selected by the user or required by an already selected Blueprint workflow. Write for a new teammate who needs to understand the point on the first read. Before finishing, reread the text. Cut words that do no work. Fix sentences that can be read two ways. Rewrite anything that sounds generated instead of written for this project.

  • 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,774 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 repository12 other files it gives its agents.

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

15 rules. About 0 are common, 14 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈14

    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
  1. Distinctive:

    Keep one skill per meaningful engineering phase or delivery outcome.

    line 8
  2. Distinctive:

    Update an existing architecture document when code changes ownership, dependency direction, protocols, stored data, trust boundaries, …

    line 12
  3. Distinctive:

    If automated tests cannot exercise the affected behavior, explain why and give other evidence.

    line 19
  4. Distinctive:

    Do not block on personal taste.

    line 21
  5. Distinctive:

    If the task, design, or plan is wrong, update it before changing more code.

    line 23
  6. Distinctive:

    Prefer the smallest complete change.

    line 24
  7. Distinctive:

    Write for a new teammate who needs to understand the point on the first read.

    line 29
  8. Distinctive:

    Use short sentences and everyday words.

    line 32
  9. Distinctive:

    Write instructions as direct commands.

    line 33
  10. Distinctive:

    Use the same word for the same thing.

    line 35
  11. Distinctive:

    Use real names, paths, commands, limits, and effects.

    line 36
  12. Distinctive:

    Use sentence case for headings.

    line 38
  13. Distinctive:

    Keep a human voice. State a judgment when the document calls for one.

    line 39
  14. Distinctive:

    Before finishing, reread the text.

    line 42
  15. Very specific:

    When the user explicitly selects /task-to-pr, follow its full delivery workflow.

    line 60

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Blueprint repository policy

Blueprint is a small set of instructions for AI coding. Blueprint skills are opt-in workflows. Use them only when explicitly selected by the user or required by an already selected Blueprint workflow.

Principles

  • Give agents outcomes, constraints, and proof. Trust them with mechanics.
  • Keep one skill per meaningful engineering phase or delivery outcome.
  • Requirements define the product. Architecture defines the intended system. A spec defines one feature or major change.
  • Distinguish accepted architecture from implemented behavior. Verify claims about existing code.
  • Review technical proposals before implementation when a wrong choice could materially affect behavior, data, security, scale, performance, compatibility, operations, cost, or proof.
  • Update an existing architecture document when code changes ownership, dependency direction, protocols, stored data, trust boundaries, deployment topology, or hard limits.
  • Skip phases that add no value. Small, decided work can go straight to implementation.
  • A task is ready when a new agent can finish it without asking product or technical questions.
  • Each pull request delivers one focused outcome and its proof. A reviewer should not have to separate unrelated work to understand it.
  • Separate refactoring when it would hide the behavior change. Small local cleanup may stay when it makes that change easier to review.
  • Logic changes include automated tests for changed behavior and affected failure paths, including any named in the acceptance criteria.
  • Refactors include tests for behavior that must not change.
  • If automated tests cannot exercise the affected behavior, explain why and give other evidence.
  • Review checks correctness. Ask for a simpler design when it can deliver the same outcome and proof with less state, indirection, duplication, or operational work.
  • Do not block on personal taste. Cite technical evidence or repository conventions.
  • Browser behavior is proven in a real browser, not by reading source.
  • If the task, design, or plan is wrong, update it before changing more code.
  • Prefer the smallest complete change. Do not mix product work with unrelated cleanup.
  • Humans review decisions and normally merge. Agents may merge only when the user explicitly delegates it. Explicitly naming /codex-issue-coordinator delegates merge authority for the supplied work after its quality gates pass; an implicit skill match does not.

Writing

Write for a new teammate who needs to understand the point on the first read.

  • Lead with the outcome, decision, or rule. Put supporting detail after it.
  • Use short sentences and everyday words. Give each sentence one main idea.
  • Write instructions as direct commands. Put a condition before the step it controls.
  • Name the actor. Prefer the parser rejects the file to the file is rejected.
  • Use the same word for the same thing. Define a necessary technical term once.
  • Use real names, paths, commands, limits, and effects. Replace vague claims with facts.
  • Cut filler, repetition, sales language, fake warmth, and generic conclusions.
  • Use sentence case for headings. Use numbered lists for sequences and bullets for real lists.
  • Keep a human voice. State a judgment when the document calls for one. Keep instructions and reference text neutral.
  • Vary sentence length when it helps the prose sound natural. Do not force every point into the same shape.

Before finishing, reread the text. Cut words that do no work. Fix sentences that can be read two ways. Rewrite anything that sounds generated instead of written for this project.

Phases

  • /requirements: define system product needs in root REQUIREMENTS.md. Stop with requirements ready for human review.
  • /architecture: design the intended system and data model, with an architecture and data flow diagram, in root ARCHITECTURE.md. Stop with architecture ready for review.
  • /spec: define one feature or major change, its technical design, and proof. The spec is the ticket. Stop before planning or implementation.
  • /architecture-review: challenge a technical proposal and surface material flaws or open questions before implementation.
  • /plan: split decided work into ordered tasks and useful milestones. Each delivers a vertical slice with acceptance checks. Stop before implementation.
  • /test: prove acceptance criteria and failure paths affected by the change, including real-browser checks when browser-rendered behavior changes.
  • /review: use a fresh subagent or another agent CLI for an independent, read-only review of spec fit and correctness.
  • /improve: inspect existing code and improve its clarity, simplicity, and structure without changing intended behavior.
  • /codex-issue-coordinator: coordinate a large GitHub issue batch through separate Codex worker threads, reviewed pull requests, and gated merges.

Workflow for code changes

For ordinary code requests, implement the smallest complete change within the agreed scope. Define acceptance checks, verify changed behavior and affected failures, review consequential changes, and follow repository delivery policy. Do not load a Blueprint skill merely because the task matches its description.

When the user explicitly selects /task-to-pr, follow its full delivery workflow.

Merge pull requests only when the user asks. Otherwise, leave them open.

Explicitly selecting /codex-issue-coordinator asks in-scope workers to merge after every required test, review, CI, approval, and mergeability gate passes. Do not select it from an implicit task match. It does not grant deployment or release authority.

Writing code is a basic agent ability, not a separate skill. Debugging and test-driven development are ways to implement a change, not separate product skills.

Outputs

  • System requirements use root REQUIREMENTS.md.
  • Intended system architecture and its data model use root ARCHITECTURE.md.
  • Feature specs default to docs/<feature-slug>/spec.md. A supplied issue or document may serve as the spec; do not duplicate it.
  • Plans are returned in chat by default or published as tracker tickets when asked. They are not stored as plan documents.
  • Pull requests use What, Why, What changed, Verification, and Risk. Verification states the real status of tests, checks, screenshots, independent review, and CI. Risk names the blast radius; database, API contract, auth, and data-deletion changes are High.

Exploration does not require a design, plan, or ticket. Do not create process artifacts that do not improve a decision, handoff, or proof.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.