agentleFS
Sign inStart free
lthoangglthoangg/OpenAgentd/documents/AGENTS.md

OpenAgentd / documents

AGENTS.md217 starsChanged 28 days agoApache-2.0View on GitHub

Product documentation is intentionally small. Run make verify-docs after documentation, README, or Markdown-link changes.

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

The file

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

5 rules. About 0 are common, 3 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep behavior, implementation detail, configuration, and operational guidance in code, tests, CLI help, and the UI rather than duplicating …

    line 15
  2. Distinctive:

    Add an inline source comment only when it explains a non-obvious invariant or decision.

    line 16
  3. Very specific:

    Keep user-facing installation and product overview in ../README.md.

    line 17
  4. Distinctive:

    Keep non-obvious rationale beside the implementation.

    line 18
  5. Very specific:

    Run make verify-docs after documentation, README, or Markdown-link changes.

    line 23

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

documents/ — Agent Instructions

Product documentation is intentionally small.

Layout

docs/     Version-cited feature catalogue and its minimal entry point
assets/   Brand, README, and screenshot assets

Rules

  • docs/features.md is the canonical catalogue of shipped user-visible features.
  • Keep behavior, implementation detail, configuration, and operational guidance in code, tests, CLI help, and the UI rather than duplicating them here.
  • Add an inline source comment only when it explains a non-obvious invariant or decision; do not restate ordinary control flow.
  • Keep user-facing installation and product overview in ../README.md.
  • Keep non-obvious rationale beside the implementation; rely on git history for historical decisions.
  • Assets remain referenced from the README or app source; do not remove an asset without checking its incoming references.

Checks

Run make verify-docs after documentation, README, or Markdown-link changes.

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.

Check your setup, free