agentleFS
hranesshraness/personal-monorepo-template/docs/AGENTS.md

personal-monorepo-template

AGENTS.md4 starsChanged 47 days agoMITView on GitHub

The file

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

4 rules. About 0 are common, 1 is distinctive, and 3 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.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Keep docs/ current and procedural.

    line 8
  2. Very specific:

    Follow WRITING.md for repository prose and STYLE.md when a document addresses readers outside the repository.

    line 9
  3. Very specific:

    Keep editorial imagery optional.

    line 11
  4. Distinctive:

    Update this guide when the directory gains a distinct documentation surface or verification requirement.

    line 12

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

Contents

  • documentation.md – current ownership rules for guides, runbooks, executable contracts, and knowledge records.
  • editorial-images.md – opt-in procedure for useful article imagery, one typed representative-image record, discovery projections, review, and performance checks.

Guidelines

  • Keep docs/ current and procedural. Put rationale, historical evidence, synthesis, and change coordination in kb/.
  • Follow WRITING.md for repository prose and STYLE.md when a document addresses readers outside the repository.
  • Link to the authoritative command, type, test, or local guide instead of copying a contract that can drift.
  • Keep editorial imagery optional. Update editorial-images.md when the representative-image workflow or its verification surfaces change.
  • Update this guide when the directory gains a distinct documentation surface or verification requirement.

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.