agentleFS
snowztechsnowztech/farol/AGENTS.md

farol

AGENTS.md20 starsChanged 32 days agoMITView on GitHub

Follow CONTRIBUTING.md. In short:

  • 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

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

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Follow CONTRIBUTING.md. In short:

    line 3
  2. Distinctive:

    Keep changes small and focused.

    line 5
  3. Very specific:

    Run make test and make lint before you finish.

    line 6
  4. Distinctive:

    Commit messages are one line, Conventional Commits style.

    line 7

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

Notes for AI coding tools

Follow CONTRIBUTING.md. In short:

  • Keep changes small and focused. Don't refactor or reformat code you weren't asked to touch.
  • Run make test and make lint before you finish.
  • Commit messages are one line, Conventional Commits style. No body, no co-author trailer.
  • PR descriptions follow .github/pull_request_template.md: two or three sentences for what and why, then short bullets. No paragraphs, no summaries of the diff, no lists of every file changed, no AI attribution footer.
  • Comments explain why, not what. No em dashes.
  • UI changes (views, color, icons, motion) follow DESIGN.md.

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.