@zhouhao4221/devflow-skills 0.2.0 → 0.3.0
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 +57 -235
- package/install.js +406 -116
- package/package.json +2 -1
- package/plugins/api/skills/api/SKILL.md +102 -0
- package/plugins/api/skills/api-field-mapper/SKILL.md +95 -0
- package/plugins/api/skills/config/SKILL.md +140 -0
- package/plugins/api/skills/gen/SKILL.md +345 -0
- package/plugins/api/skills/help/SKILL.md +121 -0
- package/plugins/api/skills/import/SKILL.md +95 -0
- package/plugins/api/skills/map/SKILL.md +152 -0
- package/plugins/api/skills/search/SKILL.md +95 -0
- package/plugins/diag/skills/audit/SKILL.md +103 -0
- package/plugins/diag/skills/diag/SKILL.md +41 -0
- package/plugins/diag/skills/diagnose/SKILL.md +167 -0
- package/plugins/diag/skills/init/SKILL.md +142 -0
- package/plugins/diag/skills/stack-analyzer/SKILL.md +150 -0
- package/plugins/pm/skills/ask/SKILL.md +89 -0
- package/plugins/pm/skills/brief/SKILL.md +95 -0
- package/plugins/pm/skills/export/SKILL.md +93 -0
- package/plugins/pm/skills/help/SKILL.md +257 -0
- package/plugins/pm/skills/milestone/SKILL.md +102 -0
- package/plugins/pm/skills/monthly/SKILL.md +111 -0
- package/plugins/pm/skills/plan/SKILL.md +96 -0
- package/plugins/pm/skills/pm/SKILL.md +174 -0
- package/plugins/pm/skills/progress/SKILL.md +113 -0
- package/plugins/pm/skills/report-generator/SKILL.md +104 -0
- package/plugins/pm/skills/risk/SKILL.md +223 -0
- package/plugins/pm/skills/standup/SKILL.md +96 -0
- package/plugins/pm/skills/stats/SKILL.md +158 -0
- package/plugins/pm/skills/weekly/SKILL.md +157 -0
- package/plugins/req/skills/branch/SKILL.md +447 -0
- package/plugins/req/skills/cache/SKILL.md +232 -0
- package/plugins/req/skills/changelog/SKILL.md +187 -0
- package/plugins/req/skills/changelog-generator/SKILL.md +106 -0
- package/plugins/req/skills/code-impact-analyzer/SKILL.md +48 -0
- package/plugins/req/skills/commit/SKILL.md +308 -0
- package/plugins/req/skills/dev/SKILL.md +229 -0
- package/plugins/req/skills/dev-guide/SKILL.md +530 -0
- package/plugins/req/skills/do/SKILL.md +191 -0
- package/plugins/req/skills/done/SKILL.md +95 -0
- package/plugins/req/skills/edit/SKILL.md +187 -0
- package/plugins/req/skills/fix/SKILL.md +300 -0
- package/plugins/req/skills/help/SKILL.md +136 -0
- package/plugins/req/skills/init/SKILL.md +505 -0
- package/plugins/req/skills/issue/SKILL.md +237 -0
- package/plugins/req/skills/issue-guide/SKILL.md +125 -0
- package/plugins/req/skills/migrate/SKILL.md +128 -0
- package/plugins/req/skills/modules/SKILL.md +195 -0
- package/plugins/req/skills/natural-language-dispatcher/SKILL.md +545 -0
- package/plugins/req/skills/new/SKILL.md +172 -0
- package/plugins/req/skills/new-quick/SKILL.md +246 -0
- package/plugins/req/skills/pr/SKILL.md +157 -0
- package/plugins/req/skills/prd/SKILL.md +187 -0
- package/plugins/req/skills/prd-analyzer/SKILL.md +131 -0
- package/plugins/req/skills/prd-edit/SKILL.md +201 -0
- package/plugins/req/skills/projects/SKILL.md +115 -0
- package/plugins/req/skills/quick-fix-guide/SKILL.md +51 -0
- package/plugins/req/skills/release/SKILL.md +300 -0
- package/plugins/req/skills/release-rationale/SKILL.md +213 -0
- package/plugins/req/skills/req/SKILL.md +173 -0
- package/plugins/req/skills/requirement-analyzer/SKILL.md +274 -0
- package/plugins/req/skills/review/SKILL.md +201 -0
- package/plugins/req/skills/review-pr/SKILL.md +699 -0
- package/plugins/req/skills/show/SKILL.md +302 -0
- package/plugins/req/skills/specs/SKILL.md +99 -0
- package/plugins/req/skills/split/SKILL.md +164 -0
- package/plugins/req/skills/status/SKILL.md +184 -0
- package/plugins/req/skills/test/SKILL.md +431 -0
- package/plugins/req/skills/test-guide/SKILL.md +304 -0
- package/plugins/req/skills/test_new/SKILL.md +417 -0
- package/plugins/req/skills/test_regression/SKILL.md +298 -0
- package/plugins/req/skills/update/SKILL.md +131 -0
- package/plugins/req/skills/update-template/SKILL.md +203 -0
- package/plugins/req/skills/upgrade/SKILL.md +178 -0
- package/plugins/req/skills/use/SKILL.md +158 -0
- package/plugins/req/skills/version-bumper/SKILL.md +113 -0
- package/plugins/uat/skills/bug/SKILL.md +153 -0
- package/plugins/uat/skills/init/SKILL.md +88 -0
- package/plugins/uat/skills/new/SKILL.md +131 -0
- package/plugins/uat/skills/report/SKILL.md +48 -0
- package/plugins/uat/skills/run/SKILL.md +78 -0
- package/plugins/uat/skills/uat/SKILL.md +64 -0
- package/plugins/uat/skills/uat-executor/SKILL.md +299 -0
|
@@ -0,0 +1,300 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: fix
|
|
3
|
+
description: |
|
|
4
|
+
轻量修复 - 无文档的 bug 修复流程,AI 辅助定位问题
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# 轻量修复
|
|
8
|
+
|
|
9
|
+
创建修复分支,AI 辅助分析定位 bug,修复后直接提交和 PR。不创建需求文档。
|
|
10
|
+
|
|
11
|
+
> **Audience:** Engineer
|
|
12
|
+
> 此命令**不受仓库角色限制**,readonly 仓库也可执行。
|
|
13
|
+
> 不触发缓存同步(无需求文档)。
|
|
14
|
+
>
|
|
15
|
+
> **CLI 优先级**:GitHub 用 `gh`;Gitea 按 [`_gitea_cli.md`](./_gitea_cli.md) 检测 `tea`,可用即走 `tea`,否则回退本文 curl 示例。
|
|
16
|
+
|
|
17
|
+
## 命令格式
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
/req:fix <问题描述> [--from-issue=#编号] [--auto]
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**`--auto` 非交互模式**:跳过修复方案确认、issue 关闭询问,修复完成后自动串联 `/req:commit` + `/req:pr`。
|
|
24
|
+
用于小 bug 一键走完,**代价是放弃方案/提交前的 review 机会**(git commit 的 hook 确认仍保留作为最后一道保险)。
|
|
25
|
+
|
|
26
|
+
示例:
|
|
27
|
+
- `/req:fix 登录超时后 token 未清除`
|
|
28
|
+
- `/req:fix 订单列表分页数据重复`
|
|
29
|
+
- `/req:fix 导出 Excel 中文文件名乱码`
|
|
30
|
+
- `/req:fix --from-issue=#42` - 从 issue 读取问题描述后分析
|
|
31
|
+
- `/req:fix 导出 Excel 中文文件名乱码 --auto` - 一键走完修复并创建 PR
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 执行流程
|
|
36
|
+
|
|
37
|
+
### 0. (可选)从 issue 读取问题描述
|
|
38
|
+
|
|
39
|
+
若命令带 `--from-issue=#N`,按 [_issue.md 的 Issue 拉取规范](./_issue.md#issue-拉取规范) 拉取 issue,把 issue 标题 + 正文拼成用户问题描述传入步骤 1。
|
|
40
|
+
|
|
41
|
+
本命令不创建需求文档,issue 编号通过**分支名 `-iN` 后缀**持久化(步骤 2.3 创建分支时追加),供 `/req:commit`、步骤 5 关闭 issue 等后续操作识别。参见 [_issue.md 的 Issue 与分支关联](./_issue.md#issue-与分支提交的关联)。
|
|
42
|
+
|
|
43
|
+
用户同时提供了描述和 `--from-issue` 时,以用户描述为主,issue 内容作为补充上下文。
|
|
44
|
+
|
|
45
|
+
### 1. AI 辅助分析 bug
|
|
46
|
+
|
|
47
|
+
> 读取项目 CLAUDE.md 的「项目架构」章节,了解分层结构和目录布局。
|
|
48
|
+
> **此阶段在当前分支上进行,不创建新分支。**
|
|
49
|
+
|
|
50
|
+
根据用户描述的问题,AI 进行定位分析:
|
|
51
|
+
|
|
52
|
+
#### 1.1 问题分析
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
Bug 分析:登录超时后 token 未清除
|
|
56
|
+
|
|
57
|
+
问题理解:
|
|
58
|
+
- 现象:用户登录超时后,本地 token 未被清除,导致后续请求携带过期 token
|
|
59
|
+
- 影响范围:认证流程、请求拦截器
|
|
60
|
+
|
|
61
|
+
可能涉及的代码:
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
#### 1.2 定位相关文件
|
|
65
|
+
|
|
66
|
+
AI 搜索代码库,定位可能相关的文件:
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
相关文件定位:
|
|
70
|
+
|
|
71
|
+
| 文件 | 相关度 | 原因 |
|
|
72
|
+
|------|-------|------|
|
|
73
|
+
| src/utils/auth.ts | 高 | token 存取逻辑 |
|
|
74
|
+
| src/interceptors/request.ts | 高 | 请求拦截,超时处理 |
|
|
75
|
+
| src/store/user.ts | 中 | 用户状态管理 |
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
#### 1.3 关联需求匹配(自动,低成本)
|
|
79
|
+
|
|
80
|
+
**目的**:找出可能引入此 bug 的需求,获取业务上下文辅助定位。
|
|
81
|
+
|
|
82
|
+
**流程**(只读索引 + 按需读正文,控制 token 消耗):
|
|
83
|
+
|
|
84
|
+
1. 读 `docs/requirements/INDEX.md`(~500 token)
|
|
85
|
+
2. 用 bug 相关文件路径 + 关键词在 INDEX.md 中模糊匹配(标题含关键词 或 模块与 bug 相关 → 命中)
|
|
86
|
+
3. 命中时仅读该需求的「十一、实现方案 - 文件改动清单」(~1k token/个,最多 2 个);未命中静默跳过
|
|
87
|
+
|
|
88
|
+
**命中时展示**:
|
|
89
|
+
|
|
90
|
+
```
|
|
91
|
+
关联需求:
|
|
92
|
+
|
|
93
|
+
| 需求 | 标题 | 关联原因 |
|
|
94
|
+
|------|------|---------|
|
|
95
|
+
| REQ-003 | 登录认证优化 | 修改了 src/interceptors/request.ts |
|
|
96
|
+
|
|
97
|
+
此 bug 可能由 REQ-003 引入,已读取其文件改动清单辅助定位。
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**未命中时**:静默跳过,不输出任何内容,不消耗额外 token。
|
|
101
|
+
|
|
102
|
+
**成本控制**:
|
|
103
|
+
|
|
104
|
+
| 步骤 | Token 消耗 | 条件 |
|
|
105
|
+
|------|-----------|------|
|
|
106
|
+
| 读 INDEX.md | ~500 | 始终执行 |
|
|
107
|
+
| 匹配关键词 | ~0 | AI 内部处理 |
|
|
108
|
+
| 读命中需求节选 | ~1k/个 | 仅命中时,最多 2 个 |
|
|
109
|
+
| **总计** | **500 ~ 2500** | 远低于全量读取(~50k) |
|
|
110
|
+
|
|
111
|
+
#### 1.4 根因分析
|
|
112
|
+
|
|
113
|
+
AI 综合代码搜索结果和关联需求上下文,给出根因判断:
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
根因分析:
|
|
117
|
+
|
|
118
|
+
在 src/interceptors/request.ts:45,响应拦截器捕获 401 状态码时
|
|
119
|
+
调用了 router.push('/login'),但未调用 removeToken()。
|
|
120
|
+
(REQ-003 登录认证优化 新增了 401 拦截逻辑,但遗漏了 token 清除)
|
|
121
|
+
|
|
122
|
+
建议修复:在跳转登录页前清除 token。
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
#### 1.5 修复建议
|
|
126
|
+
|
|
127
|
+
```
|
|
128
|
+
修复建议:
|
|
129
|
+
|
|
130
|
+
1. src/interceptors/request.ts
|
|
131
|
+
- 在 401 处理分支中,跳转前调用 removeToken()
|
|
132
|
+
|
|
133
|
+
2. 建议同时检查:
|
|
134
|
+
- token 过期的其他入口(如定时刷新失败)
|
|
135
|
+
|
|
136
|
+
是否按以上方案修复?(可以补充说明或调整方向)
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
**`--auto` 模式**:跳过"等待用户确认",直接展示方案后进入步骤 2。
|
|
140
|
+
|
|
141
|
+
**非 `--auto` 模式**:等待用户确认。用户可以:
|
|
142
|
+
- 确认方案 → 进入步骤 2
|
|
143
|
+
- 补充信息 / 调整方向 → AI 重新分析
|
|
144
|
+
- 放弃 → 结束,不创建分支
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
### 2. 创建修复分支
|
|
149
|
+
|
|
150
|
+
> **用户确认修复方案后**才创建分支,避免分析后放弃导致残留空分支。
|
|
151
|
+
|
|
152
|
+
#### 2.1 工作区检查
|
|
153
|
+
|
|
154
|
+
有未提交改动时终止,提示先 commit 或 stash。
|
|
155
|
+
|
|
156
|
+
#### 2.2 读取分支策略
|
|
157
|
+
|
|
158
|
+
从 `branchStrategy` 读取 `mainBranch`、`branchFrom`(缺省同 mainBranch)、`fixPrefix`(缺省 `fix/`);未配置时自动检测主分支。
|
|
159
|
+
|
|
160
|
+
#### 2.3 创建分支
|
|
161
|
+
|
|
162
|
+
AI 根据问题描述生成英文 slug(lowercase kebab-case,最多 5 词)。
|
|
163
|
+
|
|
164
|
+
**有 `--from-issue=#N`**:分支名末尾追加 `-i<N>`(参见 [_issue.md 的 Issue 与分支关联](./_issue.md#issue-与分支提交的关联))。
|
|
165
|
+
|
|
166
|
+
```
|
|
167
|
+
创建修复分支:fix/login-token-not-cleared-i42
|
|
168
|
+
基于:main(来源:branchStrategy.branchFrom)
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
**无 `--from-issue`**:不加 issue 后缀。
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
创建修复分支:fix/login-token-not-cleared
|
|
175
|
+
基于:main(来源:branchStrategy.branchFrom)
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
fetch `branchFrom`,从远端创建并切换到新分支(有 issue 时分支名末尾追加 `-i<N>`)。
|
|
179
|
+
|
|
180
|
+
---
|
|
181
|
+
|
|
182
|
+
### 3. 执行修复
|
|
183
|
+
|
|
184
|
+
AI 按确认的方案修改代码。
|
|
185
|
+
|
|
186
|
+
---
|
|
187
|
+
|
|
188
|
+
### 4. 修复完成提示
|
|
189
|
+
|
|
190
|
+
```
|
|
191
|
+
✅ 修复完成!
|
|
192
|
+
|
|
193
|
+
分支:fix/login-token-not-cleared
|
|
194
|
+
修改文件:
|
|
195
|
+
- src/interceptors/request.ts(+3 -1)
|
|
196
|
+
|
|
197
|
+
后续操作:
|
|
198
|
+
- /req:commit - 提交修复代码
|
|
199
|
+
- /req:pr - 创建 PR
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
若来自 `--from-issue=#N`,在后续操作提示中追加:
|
|
203
|
+
```
|
|
204
|
+
提交时建议在 commit message 末尾添加 closes #N 以自动关联 issue
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
### 4.5 (仅 `--auto` 模式)自动串联 commit + PR
|
|
210
|
+
|
|
211
|
+
非 `--auto` 模式跳过本步骤,结束命令。
|
|
212
|
+
|
|
213
|
+
`--auto` 模式下,步骤 4 展示完成提示后**立即继续执行**,不等待用户输入。
|
|
214
|
+
|
|
215
|
+
#### 4.5.0 建立 auto 标记(跳过 hook 确认)
|
|
216
|
+
|
|
217
|
+
在 commit/push/PR 前,先创建 `.claude/.req-auto` 标记文件,让 PreToolUse hook(`confirm-before-commit.sh`)在检测到该文件且 mtime 在 10 分钟内时自动放行,不再弹出原生确认对话框。
|
|
218
|
+
|
|
219
|
+
> **标记生命周期**:步骤 4.5 开始时创建,步骤 4.5 结束(成功或失败)时在 4.5.4 清理。若命令异常终止残留,10 分钟后 hook 自动忽略该标记,不会造成长期"默认放行"。
|
|
220
|
+
|
|
221
|
+
#### 4.5.1 调用 `/req:commit` 流程
|
|
222
|
+
|
|
223
|
+
参见 [commit.md](./commit.md):
|
|
224
|
+
|
|
225
|
+
- 自动暂存所有变更
|
|
226
|
+
- 从当前分支名 `fix/<slug>-iN` 中不含 REQ/QUICK 编号 → commit message 不加 `(REQ-XXX)`
|
|
227
|
+
- 若有 `--from-issue=#N`,在 commit message 末尾自动追加 `closes #N`
|
|
228
|
+
- 使用 `修复:` 前缀(fix 命令语义固定为修复)
|
|
229
|
+
- 示例:`修复: 登录超时后 token 未清除 closes #42`
|
|
230
|
+
- 执行 `git commit`(hook 检测到 `.claude/.req-auto` 自动放行,无需用户确认)
|
|
231
|
+
|
|
232
|
+
#### 4.5.2 调用 `/req:pr` 流程
|
|
233
|
+
|
|
234
|
+
参见 [pr.md](./pr.md):
|
|
235
|
+
|
|
236
|
+
- `git push -u origin <branch>`
|
|
237
|
+
- 按 `branchStrategy.repoType` 创建 PR:
|
|
238
|
+
- `gitea` → 调用 Gitea API
|
|
239
|
+
- `github` → `gh pr create`
|
|
240
|
+
- `other` → 仅输出合并命令
|
|
241
|
+
- PR 标题:`fix: <问题描述>`(无 REQ 编号)
|
|
242
|
+
- PR body 包含:问题描述、根因分析(来自步骤 1.4)、修改文件清单;若有 `closes #N` 自动关联 issue
|
|
243
|
+
|
|
244
|
+
#### 4.5.3 失败处理
|
|
245
|
+
|
|
246
|
+
任何一步失败(commit/push/PR 创建)→ **立即停止**,先执行 4.5.4 清理 marker,然后展示错误和手动恢复命令,不跳过到下一步。
|
|
247
|
+
|
|
248
|
+
#### 4.5.4 清理 auto 标记
|
|
249
|
+
|
|
250
|
+
无论成功或失败,都必须在命令结束前删除 `.claude/.req-auto`。
|
|
251
|
+
|
|
252
|
+
**成功输出**:
|
|
253
|
+
```
|
|
254
|
+
✅ 一键修复完成!
|
|
255
|
+
|
|
256
|
+
commit abc1234: 修复: 登录超时后 token 未清除 closes #42
|
|
257
|
+
PR: <url>
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
---
|
|
261
|
+
|
|
262
|
+
### 5. (可选)关闭 issue
|
|
263
|
+
|
|
264
|
+
仅当命令带 `--from-issue=#N` **且非 `--auto` 模式**时执行本步骤。
|
|
265
|
+
|
|
266
|
+
> **`--auto` 模式跳过询问**:commit message 已包含 `closes #N`,PR 合并时 Git 平台会自动关闭 issue,不需要在 PR 未合并前主动关闭。
|
|
267
|
+
|
|
268
|
+
在步骤 4 展示完成提示后,询问用户:
|
|
269
|
+
|
|
270
|
+
```
|
|
271
|
+
本次修复来自 issue #N
|
|
272
|
+
是否关闭该 issue?(y/n)
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
**用户确认(y)** → 按 `repoType` 关闭 issue,逻辑同 [issue.md §5](./issue.md)。
|
|
276
|
+
|
|
277
|
+
**用户拒绝(n)**:跳过。
|
|
278
|
+
|
|
279
|
+
> commit message 含 `closes #N` 时,PR 合并时 Git 平台会自动关闭 issue,无需手动操作。
|
|
280
|
+
|
|
281
|
+
---
|
|
282
|
+
|
|
283
|
+
## 与其他修复方式的区别
|
|
284
|
+
|
|
285
|
+
| 方式 | 命令 | 文档 | 分支 | 适用场景 |
|
|
286
|
+
|------|------|------|------|---------|
|
|
287
|
+
| 轻量修复 | `/req:fix` | 无 | fix/slug | 日常小 bug,改动 < 5 个文件 |
|
|
288
|
+
| 有记录的修复 | `/req:new-quick` | QUICK 文档 | fix/QUICK-XXX-slug | 需要记录的修复,方便追溯 |
|
|
289
|
+
| 紧急修复 | `/req:branch hotfix` | 无 | hotfix/slug | 线上紧急问题,从主分支拉 |
|
|
290
|
+
|
|
291
|
+
**选择依据:**
|
|
292
|
+
- 改完就忘的小 bug → `/req:fix`
|
|
293
|
+
- 需要测试和记录的修复 → `/req:new-quick`
|
|
294
|
+
- 线上出问题了 → `/req:branch hotfix`
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
## 用户输入
|
|
299
|
+
|
|
300
|
+
$ARGUMENTS
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: help
|
|
3
|
+
description: |
|
|
4
|
+
使用教程 - 查看插件完整使用指南
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# 使用教程
|
|
8
|
+
|
|
9
|
+
读取并展示插件使用教程,支持中文 / 英文 / 韩文三语。
|
|
10
|
+
|
|
11
|
+
## 执行流程
|
|
12
|
+
|
|
13
|
+
### 1. 决定语言
|
|
14
|
+
|
|
15
|
+
按以下优先级决定语言:
|
|
16
|
+
|
|
17
|
+
1. 命令参数 `--lang=zh|en|ko`(显式覆盖)
|
|
18
|
+
2. `.claude/settings.local.json` 的 `language` 字段
|
|
19
|
+
3. 默认 `zh`
|
|
20
|
+
|
|
21
|
+
### 2. 读取教程文件
|
|
22
|
+
|
|
23
|
+
按语言选择教程文件:
|
|
24
|
+
|
|
25
|
+
| lang | 文件路径 |
|
|
26
|
+
|------|---------|
|
|
27
|
+
| `zh`(默认) | `docs/tutorial.md` |
|
|
28
|
+
| `en` | `docs/tutorial.en.md` |
|
|
29
|
+
| `ko` | `docs/tutorial.ko.md` |
|
|
30
|
+
|
|
31
|
+
> 插件安装路径下无此文件时,回退到项目仓库根的 `docs/tutorial.<lang>.md`。
|
|
32
|
+
|
|
33
|
+
### 3. 决定输出范围
|
|
34
|
+
|
|
35
|
+
- 无章节参数 → 输出章节索引
|
|
36
|
+
- 有章节参数 → 按章节名或编号模糊匹配,仅输出对应章节
|
|
37
|
+
|
|
38
|
+
## 章节索引
|
|
39
|
+
|
|
40
|
+
无参数时展示对应语言的章节索引。
|
|
41
|
+
|
|
42
|
+
### 中文(zh)
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
需求工作流插件 - 使用教程
|
|
46
|
+
|
|
47
|
+
章节:
|
|
48
|
+
1. 安装与初始化(含架构描述、分支策略、Gitea Token 配置、reinit、缓存重建)
|
|
49
|
+
2. 创建需求
|
|
50
|
+
3. 评审流程
|
|
51
|
+
4. 开发阶段(含分支管理、PR 创建)
|
|
52
|
+
5. 测试阶段
|
|
53
|
+
6. 完成归档
|
|
54
|
+
7. 查看与管理
|
|
55
|
+
8. 模块管理
|
|
56
|
+
9. PRD 管理
|
|
57
|
+
10. 版本管理
|
|
58
|
+
11. 跨仓库协作
|
|
59
|
+
12. 完整流程图
|
|
60
|
+
|
|
61
|
+
输入章节编号查看详情,或直接阅读完整教程。
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### English (en)
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
Requirements Workflow Plugin — Tutorial
|
|
68
|
+
|
|
69
|
+
Sections:
|
|
70
|
+
1. Installation & initialization (architecture, branch strategy, Gitea token, reinit, cache rebuild)
|
|
71
|
+
2. Creating requirements
|
|
72
|
+
3. Review flow
|
|
73
|
+
4. Development (branch management, PR creation)
|
|
74
|
+
5. Testing
|
|
75
|
+
6. Archival
|
|
76
|
+
7. Browsing & management
|
|
77
|
+
8. Module management
|
|
78
|
+
9. PRD management
|
|
79
|
+
10. Versioning
|
|
80
|
+
11. Cross-repo collaboration
|
|
81
|
+
12. Full flow diagram
|
|
82
|
+
|
|
83
|
+
Enter a section number to view details, or read the full tutorial.
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### 한국어 (ko)
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
요구사항 워크플로우 플러그인 - 튜토리얼
|
|
90
|
+
|
|
91
|
+
섹션:
|
|
92
|
+
1. 설치 & 초기화 (아키텍처, 브랜치 전략, Gitea Token, 재초기화, 캐시 재구축)
|
|
93
|
+
2. 요구사항 생성
|
|
94
|
+
3. 리뷰 플로우
|
|
95
|
+
4. 개발 단계 (브랜치 관리, PR 생성)
|
|
96
|
+
5. 테스트 단계
|
|
97
|
+
6. 완료 및 아카이브
|
|
98
|
+
7. 조회 & 관리
|
|
99
|
+
8. 모듈 관리
|
|
100
|
+
9. PRD 관리
|
|
101
|
+
10. 버전 관리
|
|
102
|
+
11. 크로스 레포 협업
|
|
103
|
+
12. 전체 플로우 다이어그램
|
|
104
|
+
|
|
105
|
+
섹션 번호를 입력하여 상세 조회, 또는 전체 튜토리얼 읽기.
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## 命令格式
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
/req:help [章节名或编号] [--lang=zh|en|ko]
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
示例:
|
|
115
|
+
- `/req:help` → 中文章节索引(或 settings.local.json 中设定的语言)
|
|
116
|
+
- `/req:help --lang=en` → English section index
|
|
117
|
+
- `/req:help --lang=ko` → 한국어 섹션 인덱스
|
|
118
|
+
- `/req:help 4` → 第四章「开发阶段」
|
|
119
|
+
- `/req:help 4 --lang=en` → Section 4 "Development"
|
|
120
|
+
- `/req:help branch --lang=en` → English match on "branch management"
|
|
121
|
+
|
|
122
|
+
## 持久化语言偏好(可选)
|
|
123
|
+
|
|
124
|
+
如果想省去每次加 `--lang` 参数,在 `.claude/settings.local.json` 中设置:
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"language": "en"
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
后续所有 `/req:help`、`/api:help`、`/pm:help` 都会默认用该语言。
|
|
133
|
+
|
|
134
|
+
## 用户输入
|
|
135
|
+
|
|
136
|
+
$ARGUMENTS
|