agentleFS
ali-sheibaali-sheiba/development-workflow/AGENTS.md

development-workflow

AGENTS.md1 starsChanged 21 days agoMITView on GitHub

These instructions apply to every file in this repository unless a more local AGENTS.md overrides them. Development Workflow is an open-source, agent-agnostic set of coding-agent skills that carry a change from problem to integration. It ships adapters for Claude Code and Codex. Optimize contributions for clarity, portability, and practical use, not for the feature set of a single agent. - Read the root README.md and the relevant directory documentation before changing a skill. - Treat skills/<skill-name>/SKILL.md as the canonical definition…

The file

Show its rules and text

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

20 rules. About 0 are common, 14 are distinctive, and 6 are 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.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read the root README.md and the relevant directory documentation before changing a skill.

    line 15
  2. Very specific:

    Treat skills/<skill-name>/SKILL.md as the canonical definition of a skill.

    line 17
  3. Very specific:

    When you add, remove, or change a workflow skill under skills/, update the guide in docs/development-workflow/ in the same change so its …

    line 18
  4. Very specific:

    Treat agents/<role>.md as the canonical role definition: what a role runs, what it produces, and its non-negotiables, in plain capability …

    line 24
  5. Very specific:

    Keep harness-specific configuration in adapters/<harness>/.

    line 26
  6. Distinctive:

    Do not duplicate essential instructions across adapters.

    line 30
  7. Distinctive:

    Keep changes scoped. Do not reformat or rewrite unrelated material.

    line 33
  8. Distinctive:

    Prefer direct, testable instructions over broad advice or lengthy background.

    line 34
  9. Distinctive:

    Use progressive disclosure: place detailed examples, specifications, and source notes in supporting files.

    line 35
  10. Distinctive:

    Use lowercase kebab-case for skill directory names.

    line 37
  11. Distinctive:

    Use relative links for files within the repository and verify that new links resolve.

    line 38
  12. Distinctive:

    Use ASCII by default unless the content requires otherwise.

    line 40
  13. Distinctive:

    Do not copy an external skill into the collection without review.

    line 44
  14. Distinctive:

    Document its repository, author or organization, license, and revision.

    line 46
  15. Distinctive:

    Remove redundant, overly broad, or untestable instructions.

    line 49
  16. Very specific:

    If licensing is absent or unclear, record notes in docs/ but do not copy the source material into skills/.

    line 54
  17. Distinctive:

    Check headings, code blocks, and relative links.

    line 61
  18. Distinctive:

    Read instructions from the perspective of an agent with no prior context.

    line 63
  19. Very specific:

    Run scripts/check.sh before you finish.

    line 77
  20. Distinctive:

    When completing work, summarize what changed, what was validated, and any open licensing or portability questions.

    line 87

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

Repository Instructions

These instructions apply to every file in this repository unless a more local AGENTS.md overrides them.

Purpose

Development Workflow is an open-source, agent-agnostic set of coding-agent skills that carry a change from problem to integration. It ships adapters for Claude Code and Codex. Optimize contributions for clarity, portability, and practical use, not for the feature set of a single agent.

Working rules

  • Read the root README.md and the relevant directory documentation before changing a skill.
  • Treat skills/<skill-name>/SKILL.md as the canonical definition of a skill.
  • When you add, remove, or change a workflow skill under skills/, update the guide in docs/development-workflow/ in the same change so its plain-language pages never drift from the canonical SKILL.md files. Follow docs/development-workflow/maintaining.md to find which page to edit.
  • Treat agents/<role>.md as the canonical role definition: what a role runs, what it produces, and its non-negotiables, in plain capability terms.
  • Keep harness-specific configuration in adapters/<harness>/. An adapter wires the canonical files into a harness - tool limits, dispatch names, hooks - and points at them rather than restating any procedure. Do not pin models; workers inherit the session's model.
  • Do not duplicate essential instructions across adapters. Link to or generate from the canonical material where practical. When an adapter and a canonical file disagree, the canonical file wins and the adapter is the bug.
  • Keep changes scoped. Do not reformat or rewrite unrelated material.
  • Prefer direct, testable instructions over broad advice or lengthy background.
  • Use progressive disclosure: place detailed examples, specifications, and source notes in supporting files.
  • Use lowercase kebab-case for skill directory names.
  • Use relative links for files within the repository and verify that new links resolve.
  • Use ASCII by default unless the content requires otherwise.

Reviewing external skills

Do not copy an external skill into the collection without review.

  1. Document its repository, author or organization, license, and revision.
  2. Explain what problem it solves and which parts are worth retaining.
  3. Identify assumptions tied to a particular agent, operating system, or tool.
  4. Remove redundant, overly broad, or untestable instructions.
  5. Rewrite the selected behavior into the repository's canonical format.
  6. Preserve required attribution and confirm that the source license permits adaptation and redistribution.

If licensing is absent or unclear, record notes in docs/ but do not copy the source material into skills/.

Validation

For documentation-only changes:

  • Check headings, code blocks, and relative links.
  • Confirm examples match the documented directory layout.
  • Read instructions from the perspective of an agent with no prior context.

For any change under skills/ or agents/:

  • Confirm the guide in docs/development-workflow/ was updated in the same change, or state explicitly why no doc change was needed (for example, a change with no effect on phases, loops, gates, artifacts, or roles).
  • Confirm the catalog in skills/README.md still lists every skill, and that any affected adapter under adapters/ still resolves.
  • For a skill containing a repeat-until loop, confirm it has all four brakes: a blocking threshold, a narrowing round scope, memory of settled decisions, and a round budget ending in escalation. An unbounded loop is a defect, not rigour.

Run scripts/check.sh before you finish. It syntax-checks every shell script, runs shellcheck when installed, and verifies every relative Markdown link.

For scripts or executable assets, run the narrowest relevant checks and record any environment requirements in the skill. Hook scripts under adapters/ must be syntax-checked and executed against both a triggering and a non-triggering input before the change is accepted.

Communication

When completing work, summarize what changed, what was validated, and any open licensing or portability questions. Do not claim compatibility with an agent that was not tested.

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.