agentleFS
shinokamixshinokamix/lopper/AGENTS.md

lopper

AGENTS.md12 starsChanged 50 days agoMITView on GitHub

Read CONTRIBUTING.md before changing anything — it applies to agents too. On top of it: Write no comment by default. A comment stays only if it is one of these: - A license header. - Behaviour that something we cannot change forces on us: git, an OS, a terminal, a library or a service. - A doc comment that defines the contract of an exported name. - A link to an issue or a spec that explains a constraint the…

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

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    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:

    Read CONTRIBUTING.md before changing anything — it applies to agents too.

    line 3
  2. Distinctive:

    Never open a PR unless the developer asks for one.

    line 6
  3. Distinctive:

    Write no comment by default.

    line 10
  4. Distinctive:

    If you are unsure that a comment fits the list, delete it.

    line 18
  5. Distinctive:

    No narration, banners or commented-out code.

    line 20
  6. Distinctive:

    When our own code needs a comment to make sense, change the code instead: rename, extract a function or add a type.

    line 21
  7. Very specific:

    Keep a //nolint only when the rule is wrong for that line or checks pure style.

    line 26
  8. Distinctive:

    Delete a comment that fails these rules.

    line 28
  9. Distinctive:

    Check a claim about git, an OS or a library before you keep it.

    line 30

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

lopper

Read CONTRIBUTING.md before changing anything — it applies to agents too. On top of it:

  • Never open a PR unless the developer asks for one.

Comments

Write no comment by default. A comment stays only if it is one of these:

  • A license header.
  • Behaviour that something we cannot change forces on us: git, an OS, a terminal, a library or a service.
  • A doc comment that defines the contract of an exported name.
  • A link to an issue or a spec that explains a constraint the code cannot.

If you are unsure that a comment fits the list, delete it. Beyond that:

  • No narration, banners or commented-out code.
  • When our own code needs a comment to make sense, change the code instead: rename, extract a function or add a type.
  • A note such as "do not remove" or "IMPORTANT", or a long justification, marks a constraint the code does not enforce. Enforce it with a type, a runtime check, a test or a lint rule, then delete the note.
  • Keep a //nolint only when the rule is wrong for that line or checks pure style. If the rule guards correctness or safety, fix the code.
  • Delete a comment that fails these rules. Do not shorten it into one that fails them too.
  • Check a claim about git, an OS or a library before you keep it. Delete the comment if the claim no longer holds or the code no longer takes that path.

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.