agentleFS
shekerkammashekerkamma/cc-best-practice/CLAUDE.md

cc-best-practice

CLAUDE.md0 starsChanged 7 months agoMITView on GitHub

This is a best practices repository for Claude Code configuration, demonstrating patterns for skills, subagents, hooks, and commands. It serves as a reference implementation rather than an application codebase. Two skill patterns: agent skills (preloaded via skills: field) vs skills (invoked via Skill tool). See orchestration-workflow/orchestration-workflow.md for the complete flow diagram. Hook events configured in .claude/settings.json: PreToolUse, PostToolUse, UserPromptSubmit, Notification, Stop, SubagentStart, SubagentStop, PreCompact, SessionStart, SessionEnd, Setup, PermissionRequest, TeammateIdle, TaskCompleted, ConfigChange. Special handling: git commits trigger pretooluse-git-committing sound. Be explicit…

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. noya21th/ClaudeCode-BestPractice★ 2100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository8 other files it gives its agents.

The file

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

12 rules. About 0 are common, 9 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Keep CLAUDE.md under 200 lines per file for reliable adherence

    line 94
  2. Distinctive:

    Use commands for workflows instead of standalone agents

    line 95
  3. Distinctive:

    Create feature-specific subagents with skills (progressive disclosure) rather than general-purpose agents

    line 96
  4. Distinctive:

    Start with plan mode for complex tasks

    line 98
  5. Distinctive:

    Use human-gated task list workflow for multi-step tasks

    line 99
  6. Very specific:

    Use /doctor for diagnostics

    line 104
  7. Distinctive:

    Run long-running terminal commands as background tasks for better log visibility

    line 105
  8. Distinctive:

    Use browser automation MCPs (Claude in Chrome, Playwright, Chrome DevTools) for Claude to inspect console logs

    line 106
  9. Distinctive:

    When committing changes, create separate commits per file.

    line 111
  10. Distinctive:

    Commit 1: git add README.md → commit with README-specific message

    line 114
  11. Very specific:

    Commit 2: git add best-practice/claude-subagents.md → commit with subagents-doc-specific message

    line 115
  12. Very specific:

    Commit 3: git add .claude/skills/weather-fetcher/SKILL.md → commit with skill-specific message

    line 116

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 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

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Repository Overview

This is a best practices repository for Claude Code configuration, demonstrating patterns for skills, subagents, hooks, and commands. It serves as a reference implementation rather than an application codebase.

Key Components

Weather System (Example Workflow)

A demonstration of two distinct skill patterns via the Command → Agent → Skill architecture:

  • /weather-orchestrator command (.claude/commands/weather-orchestrator.md): Entry point — asks user for C/F, invokes agent, then invokes SVG skill
  • weather-agent agent (.claude/agents/weather-agent.md): Fetches temperature using its preloaded weather-fetcher skill (agent skill pattern)
  • weather-fetcher skill (.claude/skills/weather-fetcher/SKILL.md): Preloaded into agent — instructions for fetching temperature from Open-Meteo
  • weather-svg-creator skill (.claude/skills/weather-svg-creator/SKILL.md): Skill — creates SVG weather card, writes orchestration-workflow/weather.svg and orchestration-workflow/output.md

Two skill patterns: agent skills (preloaded via skills: field) vs skills (invoked via Skill tool). See orchestration-workflow/orchestration-workflow.md for the complete flow diagram.

Skill Definition Structure

Skills in .claude/skills/<name>/SKILL.md use YAML frontmatter:

  • name: Display name and /slash-command (defaults to directory name)
  • description: When to invoke (recommended for auto-discovery)
  • argument-hint: Autocomplete hint (e.g., [issue-number])
  • disable-model-invocation: Set true to prevent automatic invocation
  • user-invocable: Set false to hide from / menu (background knowledge only)
  • allowed-tools: Tools allowed without permission prompts when skill is active
  • model: Model to use when skill is active
  • context: Set to fork to run in isolated subagent context
  • agent: Subagent type for context: fork (default: general-purpose)
  • hooks: Lifecycle hooks scoped to this skill

Presentation System

See .claude/rules/presentation.md — all presentation work is delegated to the presentation-curator agent.

Hooks System

Cross-platform sound notification system in .claude/hooks/:

  • scripts/hooks.py: Main handler for Claude Code hook events
  • config/hooks-config.json: Shared team configuration
  • config/hooks-config.local.json: Personal overrides (git-ignored)
  • sounds/: Audio files organized by hook event (generated via ElevenLabs TTS)

Hook events configured in .claude/settings.json: PreToolUse, PostToolUse, UserPromptSubmit, Notification, Stop, SubagentStart, SubagentStop, PreCompact, SessionStart, SessionEnd, Setup, PermissionRequest, TeammateIdle, TaskCompleted, ConfigChange.

Special handling: git commits trigger pretooluse-git-committing sound.

Critical Patterns

Subagent Orchestration

Subagents cannot invoke other subagents via bash commands. Use the Agent tool (renamed from Task in v2.1.63; Task(...) still works as an alias):

Agent(subagent_type="agent-name", description="...", prompt="...", model="haiku")

Be explicit about tool usage in subagent definitions. Avoid vague terms like "launch" that could be misinterpreted as bash commands.

Subagent Definition Structure

Subagents in .claude/agents/*.md use YAML frontmatter:

  • name: Subagent identifier
  • description: When to invoke (use "PROACTIVELY" for auto-invocation)
  • tools: Comma-separated allowlist of tools (inherits all if omitted). Supports Agent(agent_type) syntax
  • disallowedTools: Tools to deny, removed from inherited or specified list
  • model: Model alias: haiku, sonnet, opus, or inherit (default: inherit)
  • permissionMode: Permission mode (e.g., "acceptEdits", "plan", "bypassPermissions")
  • maxTurns: Maximum agentic turns before the subagent stops
  • skills: List of skill names to preload into agent context
  • mcpServers: MCP servers for this subagent (server names or inline configs)
  • hooks: Lifecycle hooks scoped to this subagent (all hook events are supported; PreToolUse, PostToolUse, and Stop are the most common)
  • memory: Persistent memory scope — user, project, or local (see reports/claude-agent-memory.md)
  • background: Set to true to always run as a background task
  • effort: Effort level override: low, medium, high, max (default: inherits from session)
  • isolation: Set to "worktree" to run in a temporary git worktree
  • color: CLI output color for visual distinction

Configuration Hierarchy

  1. Managed (managed-settings.json / MDM plist / Registry): Organization-enforced, cannot be overridden
  2. Command line arguments: Single-session overrides
  3. .claude/settings.local.json: Personal project settings (git-ignored)
  4. .claude/settings.json: Team-shared settings
  5. ~/.claude/settings.json: Global personal defaults
  6. hooks-config.local.json overrides hooks-config.json

Disable Hooks

Set "disableAllHooks": true in .claude/settings.local.json, or disable individual hooks in hooks-config.json.

Answering Best Practice Questions

When the user asks a Claude Code best practice question, always search this repo first (best-practice/, reports/, tips/, implementation/, and README.md) before relying on training knowledge or external sources. This repo is the authoritative source — only fall back to external docs or web search if the answer is not found here.

Workflow Best Practices

From experience with this repository:

  • Keep CLAUDE.md under 200 lines per file for reliable adherence
  • Use commands for workflows instead of standalone agents
  • Create feature-specific subagents with skills (progressive disclosure) rather than general-purpose agents
  • Perform manual /compact at ~50% context usage
  • Start with plan mode for complex tasks
  • Use human-gated task list workflow for multi-step tasks
  • Break subtasks small enough to complete in under 50% context

Debugging Tips

  • Use /doctor for diagnostics
  • Run long-running terminal commands as background tasks for better log visibility
  • Use browser automation MCPs (Claude in Chrome, Playwright, Chrome DevTools) for Claude to inspect console logs
  • Provide screenshots when reporting visual issues

Git Commit Rules

When committing changes, create separate commits per file. Do NOT bundle multiple file changes into a single commit. Each file gets its own commit with a descriptive message specific to that file's changes.

For example, if README.md, best-practice/claude-subagents.md, and a skill file all changed:

  • Commit 1: git add README.md → commit with README-specific message
  • Commit 2: git add best-practice/claude-subagents.md → commit with subagents-doc-specific message
  • Commit 3: git add .claude/skills/weather-fetcher/SKILL.md → commit with skill-specific message

This makes the git history cleaner and easier to review, revert, or cherry-pick individual changes.

Documentation

See .claude/rules/markdown-docs.md for documentation standards. Key docs:

  • best-practice/claude-subagents.md: Subagent frontmatter, hooks, and repository agents
  • best-practice/claude-commands.md: Slash command patterns and built-in command reference
  • orchestration-workflow/orchestration-workflow.md: Weather system flow diagram

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.