CLAUDE.md

1# CLAUDE.md
2 
3本文件为 Claude Code (claude.ai/code) 在此仓库中处理代码提供指导。
4 
5## 项目概览 (Project Overview)
6 
7这是一个 **Claude Code 插件 (Plugin)** —— 一个包含生产级智能体 (Agents)、技能 (Skills)、钩子 (Hooks)、命令 (Commands)、规则 (Rules) 及 MCP 配置 (MCP Configurations) 的集合。本项目为使用 Claude Code 进行软件开发提供了经受过实战检验的工作流 (Workflows)。
8 
9## 运行测试 (Running Tests)
10 
11```bash
12# 运行所有测试
13node tests/run-all.js
14 
15# 运行单个测试文件
16node tests/lib/utils.test.js
17node tests/lib/package-manager.test.js
18node tests/hooks/hooks.test.js
19```
20 
21## 架构设计 (Architecture)
22 
23项目由以下核心组件组成：
24 
25- **agents/** - 用于委派 (Delegation) 的专业子智能体 (Subagents)（如 planner、code-reviewer、tdd-guide 等）
26- **skills/** - 工作流 (Workflow) 定义与领域知识（如编码标准、模式、测试）
27- **commands/** - 用户调用的斜杠命令 (Slash Commands)（如 `/tdd`、`/plan`、`/e2e` 等）
28- **hooks/** - 基于触发器的自动化（如会话持久化、工具使用前/后钩子）
29- **rules/** - 必须始终遵守的准则（如安全性、编码风格、测试要求）
30- **mcp-configs/** - 用于外部集成的 MCP 服务配置
31- **scripts/** - 用于钩子与设置的跨平台 Node.js 工具
32- **tests/** - 针对脚本与工具的测试套件
33 
34## 核心命令 (Key Commands)
35 
36- `/tdd` - 测试驱动开发 (TDD) 工作流
37- `/plan` - 实现方案规划 (Implementation Planning)
38- `/e2e` - 生成并运行端到端 (E2E) 测试
39- `/code-review` - 质量审查 (Quality Review)
40- `/build-fix` - 修复构建错误
41- `/learn` - 从会话 (Sessions) 中提取模式
42- `/skill-create` - 从 Git 历史记录生成技能
43 
44## 开发注意事项 (Development Notes)
45 
46- 包管理器 (Package manager) 检测：支持 npm, pnpm, yarn, bun（可通过 `CLAUDE_PACKAGE_MANAGER` 环境变量或项目配置进行设置）
47- 跨平台：通过 Node.js 脚本支持 Windows, macOS, Linux
48- 智能体 (Agent) 格式：带有 YAML Frontmatter (元数据前置块) 的 Markdown 文件（包含名称、描述、工具、模型）
49- 技能 (Skill) 格式：包含明确章节（何时使用、工作原理、示例）的 Markdown 文件
50- 钩子 (Hook) 格式：包含匹配 (Matcher) 条件以及命令/通知钩子的 JSON 文件
51 
52## 贡献指南 (Contributing)
53 
54请遵循 CONTRIBUTING.md 中的格式要求：
55- 智能体 (Agents)：带有 Frontmatter (name, description, tools, model) 的 Markdown 文件
56- 技能 (Skills)：明确的章节划分（何时使用、工作原理、示例）
57- 命令 (Commands)：带有描述性 Frontmatter 的 Markdown 文件
58- 钩子 (Hooks)：带有匹配器 (Matcher) 和钩子数组的 JSON 文件
59 
60文件命名：小写字母加连字符（例如：`python-reviewer.md`, `tdd-workflow.md`）
61