@stormhwdev/claude-config 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +161 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
# @stormhwdev/claude-config
|
|
2
|
+
|
|
3
|
+
Claude Code Agent Team 研发规范配置包。通过 `npx` 一键安装 agents、rules、templates 到 `~/.claude/`，并将项目级 `CLAUDE.md` 应用到任意项目。
|
|
4
|
+
|
|
5
|
+
## 这是什么
|
|
6
|
+
|
|
7
|
+
一套为 Claude Code 设计的**多 Agent 协作研发规范**，包含：
|
|
8
|
+
|
|
9
|
+
- **7 个专业 Agent** — 覆盖产品、架构、开发、测试全流程
|
|
10
|
+
- **8 条编码规则** — 统一团队的代码风格、测试、安全等实践
|
|
11
|
+
- **11 个文档模板** — 标准化 PRD、契约、架构设计等文档输出
|
|
12
|
+
- **项目级 CLAUDE.md** — 定义完整的 Agent Team 研发流程规范
|
|
13
|
+
- **[设计理念](docs/design-philosophy.md)** — 职责划分、DDD、TDD、契约驱动背后的设计思考
|
|
14
|
+
|
|
15
|
+
### Agent 团队
|
|
16
|
+
|
|
17
|
+
| Agent | 角色 | 职责 |
|
|
18
|
+
|-------|------|------|
|
|
19
|
+
| `product-manager` | 产品经理 | 编写 PRD，梳理需求 |
|
|
20
|
+
| `domain-expert` | 业务领域专家 | 提供领域知识，参与领域建模 |
|
|
21
|
+
| `interaction-designer` | 交互设计专家 | 产出 HTML/CSS 交互原型 |
|
|
22
|
+
| `backend-architect` | 后端架构师 | DDD 领域建模、模块拆分、契约定义 |
|
|
23
|
+
| `backend-developer` | 后端开发工程师 | TDD 模块开发、接口实现 |
|
|
24
|
+
| `frontend-developer` | 前端开发工程师 | 页面开发、API 对接 |
|
|
25
|
+
| `integration-tester` | 集成测试专家 | 集成测试、回归测试 |
|
|
26
|
+
|
|
27
|
+
### 编码规则
|
|
28
|
+
|
|
29
|
+
| 规则文件 | 内容 |
|
|
30
|
+
|----------|------|
|
|
31
|
+
| `coding-style.md` | Go 代码风格（gofmt、接口设计） |
|
|
32
|
+
| `testing.md` | Go 测试规范（table-driven、race detection） |
|
|
33
|
+
| `patterns.md` | Go 设计模式（functional options、DI） |
|
|
34
|
+
| `security.md` | 安全实践（secret 管理、context 超时） |
|
|
35
|
+
| `git-workflow.md` | Git 工作流与 commit 规范 |
|
|
36
|
+
| `performance.md` | 模型选择策略、上下文管理 |
|
|
37
|
+
| `agents.md` | Agent 编排与并行任务策略 |
|
|
38
|
+
| `hooks.md` | PostToolUse 钩子配置 |
|
|
39
|
+
|
|
40
|
+
### 文档模板
|
|
41
|
+
|
|
42
|
+
| 模板 | 用途 |
|
|
43
|
+
|------|------|
|
|
44
|
+
| `PRD.md.tpl` | 产品需求文档 |
|
|
45
|
+
| `prd-feature.md.tpl` | PRD 功能需求明细 |
|
|
46
|
+
| `contracts.md.tpl` | 模块接口契约 |
|
|
47
|
+
| `design-overview.md.tpl` | 模块设计概览 |
|
|
48
|
+
| `feature.md.tpl` | 功能详细设计 |
|
|
49
|
+
| `module-dependencies.md.tpl` | 模块间依赖关系 |
|
|
50
|
+
| `service-dependencies.md.tpl` | 跨服务依赖关系 |
|
|
51
|
+
| `topology.md.tpl` | 项目拓扑与路径映射 |
|
|
52
|
+
| `lifecycle.md.tpl` | 分支生命周期跟踪 |
|
|
53
|
+
| `lifecycle-archive-index.md.tpl` | 迭代归档索引 |
|
|
54
|
+
| `changelog.md.tpl` | 模块变更日志 |
|
|
55
|
+
|
|
56
|
+
## 安装
|
|
57
|
+
|
|
58
|
+
### 方式一：npx（推荐）
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
# 安装用户级配置到 ~/.claude/
|
|
62
|
+
npx @stormhwdev/claude-config init
|
|
63
|
+
|
|
64
|
+
# 在目标项目中应用 CLAUDE.md
|
|
65
|
+
cd your-project
|
|
66
|
+
npx @stormhwdev/claude-config apply
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 方式二：clone + install.sh
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
git clone <repo-url>
|
|
73
|
+
cd claude-config
|
|
74
|
+
./install.sh
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## CLI 命令
|
|
78
|
+
|
|
79
|
+
| 命令 | 说明 |
|
|
80
|
+
|------|------|
|
|
81
|
+
| `init` | 安装/更新用户级配置（agents、rules、templates、settings）到 `~/.claude/` |
|
|
82
|
+
| `apply` | 将 `CLAUDE.md` 模板复制到当前目录 |
|
|
83
|
+
| `status` | 查看配置安装状态 |
|
|
84
|
+
| `help` | 显示帮助信息 |
|
|
85
|
+
|
|
86
|
+
**选项：**
|
|
87
|
+
|
|
88
|
+
| 选项 | 说明 |
|
|
89
|
+
|------|------|
|
|
90
|
+
| `--force`, `-f` | 跳过确认提示，强制覆盖 |
|
|
91
|
+
|
|
92
|
+
### 示例
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
# 查看当前配置状态
|
|
96
|
+
npx @stormhwdev/claude-config status
|
|
97
|
+
|
|
98
|
+
# 强制更新，跳过确认
|
|
99
|
+
npx @stormhwdev/claude-config init --force
|
|
100
|
+
|
|
101
|
+
# 更新到最新版本
|
|
102
|
+
npx @stormhwdev/claude-config@latest init
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## 更新
|
|
106
|
+
|
|
107
|
+
当规则、agent 或模板有更新时：
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
# 发布新版本（维护者）
|
|
111
|
+
npm version patch
|
|
112
|
+
npm publish --access public
|
|
113
|
+
|
|
114
|
+
# 获取最新配置（使用者）
|
|
115
|
+
npx @stormhwdev/claude-config@latest init
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
`settings.json` 采用**深度合并**策略，更新时不会覆盖用户已有的自定义设置。
|
|
119
|
+
|
|
120
|
+
## 配置安装位置
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
~/.claude/
|
|
124
|
+
├── agents/ # Agent 定义（7 个）
|
|
125
|
+
├── rules/ # 编码规则（8 条）
|
|
126
|
+
├── templates/ # 文档模板（11 个）
|
|
127
|
+
└── settings.json # Claude Code 设置（合并写入）
|
|
128
|
+
|
|
129
|
+
your-project/
|
|
130
|
+
└── CLAUDE.md # 项目级研发规范（apply 命令写入）
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## 研发流程概览
|
|
134
|
+
|
|
135
|
+
`CLAUDE.md` 定义了一套完整的 Agent Team 协作流程：
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
Phase 0: 基线建档（存量项目接入）
|
|
139
|
+
↓ 人工确认
|
|
140
|
+
Phase 1: 需求分析与 PRD
|
|
141
|
+
↓ 人工确认
|
|
142
|
+
Phase 2: 交互设计（按需）
|
|
143
|
+
↓ 人工确认
|
|
144
|
+
Phase 3: 架构设计（DDD）
|
|
145
|
+
↓ 大型改造需人工确认
|
|
146
|
+
Phase 4: 并行开发（TDD）
|
|
147
|
+
↓
|
|
148
|
+
Phase 5: 集成测试
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
根据需求规模自动判断启动哪些角色：
|
|
152
|
+
|
|
153
|
+
- **基线建档** — 存量项目首次接入，全面梳理文档
|
|
154
|
+
- **小型改造** — 单模块变更、Bug 修复
|
|
155
|
+
- **大型改造** — 跨模块变更、架构级改造
|
|
156
|
+
|
|
157
|
+
详细规范参见 `CLAUDE.md.template`。
|
|
158
|
+
|
|
159
|
+
## License
|
|
160
|
+
|
|
161
|
+
MIT
|