agentleFS
zth9zth9/skills/CLAUDE.md

skills

CLAUDE.md2 starsChanged 10 months agoMITView on GitHub

The description field in SKILL.md must include two parts: 1. What it does: Brief description of the skill's functionality 2. When to use: Tell the agent when to trigger this skill Example format: Bad example (missing trigger condition): To reduce token consumption, use progressive disclosure when a skill has many scripts or complex documentation: Example INDEX.md structure:

The file

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

8 rules. About 0 are common, 2 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Commit messages must be in English

    line 5
  2. Very specific:

    Use lowercase with hyphens (kebab-case), e.g., mac-notifier, mermaid-to-img

    line 10
  3. Distinctive:

    When renaming a skill, update all three locations:

    line 12
  4. Very specific:

    When adding a new skill, update both README.md (Chinese) and README_EN.md (English)

    line 19
  5. Very specific:

    Add the new skill to the "Available Skills" table in both files

    line 20
  6. Very specific:

    For skills with 3+ scripts: Create a scripts/INDEX.md file that briefly describes each script's purpose

    line 42
  7. Very specific:

    Main SKILL.md: Only include the most common usage and reference INDEX.md for details

    line 43
  8. Very specific:

    Detailed docs: Put comprehensive documentation in separate files (e.g., docs/ folder)

    line 44

≈ “Common” is an estimate: at least 1 in 5 of the 27,641 CLAUDE.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
CLAUDE.md

Project Guidelines

Commit Rules

  • Commit messages must be in English

Skill Naming Convention

  • The skill directory name, SKILL.md name field, and plugin name must be identical
  • Use lowercase with hyphens (kebab-case), e.g., mac-notifier, mermaid-to-img
  • This ensures consistency between /skill-name commands and plugin management
  • When renaming a skill, update all three locations:
    1. Directory name
    2. SKILL.md name field
    3. .claude-plugin/marketplace.json plugin name and skills path

README Updates

  • When adding a new skill, update both README.md (Chinese) and README_EN.md (English)
  • Add the new skill to the "Available Skills" table in both files

Skill Description Rules

The description field in SKILL.md must include two parts:

  1. What it does: Brief description of the skill's functionality
  2. When to use: Tell the agent when to trigger this skill

Example format:

description: Convert Mermaid diagrams to images. Use when user wants to export/save/convert Mermaid code to PNG/JPG/SVG/PDF format.

Bad example (missing trigger condition):

description: Convert Mermaid diagrams to images.

Progressive Disclosure

To reduce token consumption, use progressive disclosure when a skill has many scripts or complex documentation:

  1. For skills with 3+ scripts: Create a scripts/INDEX.md file that briefly describes each script's purpose
  2. Main SKILL.md: Only include the most common usage and reference INDEX.md for details
  3. Detailed docs: Put comprehensive documentation in separate files (e.g., docs/ folder)

Example INDEX.md structure:

# Scripts Index

| Script | Purpose |
|--------|---------|
| main.py | Primary entry point for basic usage |
| install.sh | Installation and setup |
| utils.py | Internal utilities (not for direct use) |

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.