agentleFS
yokingmayokingma/flow-diagram-skill/AGENTS.md

flow-diagram-skill

AGENTS.md1 starsChanged 3 days agoMITView on GitHub

This repository owns Flow Diagram Skill authoring, layout plans, checks, reviews, delivery, and its isolated runtime. The SDK is a separately versioned public dependency. Keep installed resources inside skills/flow-diagram/; repository tests, tools, guides, and maintenance documents stay outside it. Track specs and issues as local Markdown under .scratch/; follow tracker rules. Use the five default triage roles as local ticket status strings; follow triage labels. Use the single-context layout: root GLOSSARY.md and docs/adr/; follow domain documentation.

  • 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 32,671 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.

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    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:

    Before changing a domain contract, read GLOSSARY.md and the relevant ADRs.

    line 5
  2. Distinctive:

    Before changing CLI behavior or modules, read PATTERNS.md, CLI patterns, and source-comment rules.

    line 6
  3. Distinctive:

    Before adding or reorganizing documentation, read the documentation scope.

    line 8
  4. Distinctive:

    Before writing technical documentation or source comments, read technical writing.

    line 9
  5. Distinctive:

    When changing Agent guidance, keep installed references self-contained.

    line 10
  6. Distinctive:

    Use the five default triage roles as local ticket status strings.

    line 21
  7. Very specific:

    Use the single-context layout: root GLOSSARY.md and docs/adr/.

    line 25

≈ “Common” is an estimate: at least 1 in 5 of the 41,581 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 work

This repository owns Flow Diagram Skill authoring, layout plans, checks, reviews, delivery, and its isolated runtime. The SDK is a separately versioned public dependency. Keep installed resources inside skills/flow-diagram/; repository tests, tools, guides, and maintenance documents stay outside it.

  • Before changing a domain contract, read GLOSSARY.md and the relevant ADRs.
  • Before changing CLI behavior or modules, read PATTERNS.md, CLI patterns, and source-comment rules. Preserve the exact SDK baseline unless the task explicitly changes it.
  • For implementation or structure changes, update the root changelog and affected patterns, then synchronize affected READMEs and guides. Verify observable CLI behavior. New or changed behavior tests must fail before implementation; pure test relocation retains assertions and records its scope.
  • Before adding or reorganizing documentation, read the documentation scope.
  • Before writing technical documentation or source comments, read technical writing. Apply its completion checks to every changed passage.
  • When changing Agent guidance, keep installed references self-contained. Keep bilingual user guides aligned by task, prerequisites, defaults, failure behavior, and examples.
  • Report delivery completion, programmatic checks, actual viewing, and unperformed checks separately. Historical source evidence is not current independent acceptance; configured CI is not executed CI.

Agent skills

Issue tracker

Track specs and issues as local Markdown under .scratch/; follow tracker rules.

Triage labels

Use the five default triage roles as local ticket status strings; follow triage labels.

Domain docs

Use the single-context layout: root GLOSSARY.md and docs/adr/; follow domain documentation.

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.