Back to Rules
๐Ÿ“‹

Awesome Claude Notes CLAUDE.md

๐Ÿ„ ๅธฎๅŠฉไฝ ๅฟซ้€Ÿๆญๅปบ Claude Code ไธŽ AI Agent ็”ŸไบงๅŠ›ๅทฅไฝœๆต็š„ๅฎžๆˆ˜ไป“ๅบ“ ๐Ÿ„ A practical toolkit to help you quickly build high-productivity workflows for Claude Code and AI agents

loulanyue

by @loulanyue

Sourced from loulanyue/awesome-claude-notes โ€” MIT

View profile
CLAUDE.md
> Sourced from [loulanyue/awesome-claude-notes](https://github.com/loulanyue/awesome-claude-notes) โ€” [MIT](https://github.com/loulanyue/awesome-claude-notes/blob/47bbbc2d715eb7cedcabd3f5d14c59fbc59e3e82/docs/ja-JP/examples/user-CLAUDE.md).

# CLAUDE.md

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

## Project Overview

This is a **Claude Code plugin** - a collection of production-ready agents, skills, hooks, commands, rules, and MCP configurations. The project provides battle-tested workflows for software development using Claude Code.

## Running Tests

```bash
# Run all tests
node tests/run-all.js

# Run individual test files
node tests/lib/utils.test.js
node tests/lib/package-manager.test.js
node tests/hooks/hooks.test.js
```

## Architecture

The project is organized into several core components:

- **agents/** - Specialized subagents for delegation (planner, code-reviewer, tdd-guide, etc.)
- **skills/** - Workflow definitions and domain knowledge (coding standards, patterns, testing)
- **commands/** - Slash commands invoked by users (/tdd, /plan, /e2e, etc.)
- **hooks/** - Trigger-based automations (session persistence, pre/post-tool hooks)
- **rules/** - Always-follow guidelines (security, coding style, testing requirements)
- **mcp-configs/** - MCP server configurations for external integrations
- **scripts/** - Cross-platform Node.js utilities for hooks and setup
- **tests/** - Test suite for scripts and utilities

## Key Commands

- `/tdd` - Test-driven development workflow
- `/plan` - Implementation planning
- `/e2e` - Generate and run E2E tests
- `/code-review` - Quality review
- `/build-fix` - Fix build errors
- `/learn` - Extract patterns from sessions
- `/skill-create` - Generate skills from git history

## Development Notes

- Package manager detection: npm, pnpm, yarn, bun (configurable via `CLAUDE_PACKAGE_MANAGER` env var or project config)
- Cross-platform: Windows, macOS, Linux support via Node.js scripts
- Agent format: Markdown with YAML frontmatter (name, description, tools, model)
- Context format: Markdown with description frontmatter and a shared navigation footer
- Skill format: Markdown with clear sections for when to use, how it works, examples
- Skill placement: Curated in skills/; generated/imported under ~/.claude/skills/. See docs/SKILL-PLACEMENT-POLICY.md
- Hook format: JSON with matcher conditions and command/notification hooks

## Contributing

Follow the formats in CONTRIBUTING.md:
- Agents: Markdown with frontmatter (name, description, tools, model)
- Contexts: Markdown with description frontmatter and a `## Navigation` section
- Skills: Clear sections (When to Use, How It Works, Examples)
- Commands: Markdown with description frontmatter and a `## Navigation` section
- Hooks: JSON with matcher and hooks array

File naming: lowercase with hyphens (e.g., `python-reviewer.md`, `tdd-workflow.md`)

Add to your project

Paste into your project's CLAUDE.md or ~/.claude/CLAUDE.md for global rules.

More for Python

MCP servers for Python

Browse all MCP servers โ†’

Browse by Tag

Get the Claude Code Starter Pack

Top CLAUDE.md rules for Next.js, TypeScript, Python, Go, and React โ€” free.