agentleFS
Sign inStart free
ntaffziintaffzii/Skill-Agents/skills/project-docs-prep/templates/AGENTS.md

Skill-Agents / templates

AGENTS.md4 starsChanged 2 months agoMITView on GitHub

The file

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

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

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No direct DOM mutations: Always use component state / frameworks logic.

    line 26
  2. Very specific:

    Strict TypeScript: Do not use any type casting without explicit comment explanation.

    line 27
  3. Very specific:

    No Emoji in UI: Use Lucide Icons (lucide-react / inline SVGs) for visual indicators.

    line 28

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

Operational Guide for AI Agents — {{PROJECT_NAME}}

Build, Test & Lint Commands

# Build
{{package_manager}} run build

# Test
{{package_manager}} run test
{{package_manager}} run test:e2e

# Lint & Format
{{package_manager}} run lint
{{package_manager}} run format

Directory Structure & Conventions

  • Source code lives in src/
  • Component naming: PascalCase for components (Button.tsx), camelCase for utility files/hooks (useAuth.ts)
  • Component modularity: Keep UI primitives in src/components/ui/ and domain features in src/components/features/

Hard Constraints

  1. No direct DOM mutations: Always use component state / frameworks logic.
  2. Strict TypeScript: Do not use any type casting without explicit comment explanation.
  3. No Emoji in UI: Use Lucide Icons (lucide-react / inline SVGs) for visual indicators.
  4. Token Efficiency: Omit facts inferable from code; keep instructions concise.

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