agentleFS
fmindfmind/dot/skills/repository-docs/references/agents.md

dot / references

AGENTS.md13 starsChanged 4 days agoMITView on GitHub

Keep each instruction layer focused: the global persona owns durable personal preferences, project instructions own repository invariants, and skills own reusable procedures. Lead every rule with a bold summary, **<2–6 word rule>**: <detail>, stating the rule rather than its topic, so reading only the bold conveys every rule; reference entries (workflows, paths, fields) may lead with their name, and link lists need none. Give an agent the repository-specific information required to change the project correctly without copying global defaults. Keep…

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    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:

    Ground preferences: use explicit requests, repeated corrections, and a bounded sample of user-authored prompts.

    line 7
  2. Distinctive:

    Resolve friction: check whether blanket rules cause unnecessary questions, redundant research, speculative abstractions, or unsafe …

    line 9
  3. Distinctive:

    Inspect the contract: read ancestor and local instructions, manifests, mise tasks, hooks, CI, and the relevant source tree.

    line 17
  4. Distinctive:

    Verify and trim: run safe documented commands and link or format checks.

    line 22
  5. Very specific:

    Keep one instruction body in AGENTS.md and use host bridges instead of copies.

    line 24

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

AGENTS.md Guidance

Keep each instruction layer focused: the global persona owns durable personal preferences, project instructions own repository invariants, and skills own reusable procedures. Lead every rule with a bold summary, **<2–6 word rule>**: <detail>, stating the rule rather than its topic, so reading only the bold conveys every rule; reference entries (workflows, paths, fields) may lead with their name, and link lists need none.

Global persona

  1. Ground preferences: use explicit requests, repeated corrections, and a bounded sample of user-authored prompts; distinguish these from assistant suggestions, stale plans, or one-off project choices. Do not copy private transcripts into shared files.
  2. Keep frequent decisions close: communication, initiative, engineering taste, scope, authorization, and completion standards belong in the persona; tool inventories and authoring recipes belong with their owning skills.
  3. Resolve friction: check whether blanket rules cause unnecessary questions, redundant research, speculative abstractions, or unsafe automation. Preserve the underlying intent with a concrete decision rule.
  4. Offload without losing meaning: map each removed requirement to an existing skill, move uncovered guidance to its owner, and repair inbound references. Retain only useful routing cues; never require loading the whole catalog.
  5. Review behavior: walk through a small fix in a dirty tree, an advice-only request, a broad review, an authorized release, a blocked check, and a stop request. Verify each yields a clear next action; prose review and package checks do not establish live host compliance.

Project instructions

Give an agent the repository-specific information required to change the project correctly without copying global defaults.

  1. Inspect the contract: read ancestor and local instructions, manifests, mise tasks, hooks, CI, and the relevant source tree; identify rules that differ from global defaults.
  2. State identity and scope: give a short project purpose, supported stack, and links to human setup documentation; explain which subtree a nested instruction file governs.
  3. Document verified commands: setup, focused checks, complete gate, build, and watch using actual task names; separate workstation checks and consequential release or deploy operations.
  4. Record local invariants: architecture seams, generated-file ownership, source versus deployed paths, private-data constraints, and non-obvious validation requirements.
  5. Map the layout: list important top-level paths with one sentence each; link multi-step workflows to .agents/skills/<name>/SKILL.md or the relevant shared skill.
  6. Verify and trim: run safe documented commands and link or format checks; remove stale advice, copied global rules, and commands the repository does not provide.

Keep one instruction body in AGENTS.md and use host bridges instead of copies. Distinguish hard invariants from recommendations, use repository-relative or ~-relative paths, preserve the repository's Markdown style, and never include credentials or transient session state.

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.