docs: 新增代码审查提示词
This commit is contained in:
@@ -9,6 +9,7 @@
|
||||
| [prompt-smart-merge.md](prompt-smart-merge.md) | 批量合并 `dev*` 分支到目标分支,含规则探测、依赖分析、冲突处理、安全回退 |
|
||||
| [prompt-proposal-review.md](prompt-proposal-review.md) | 审查 fast-drive design/tasks 与讨论、实际状态、OpenSpec workflow 的一致性 |
|
||||
| [prompt-apply-review.md](prompt-apply-review.md) | 审查 apply 后实际产物、验证、design/tasks 的一致性,并补齐遗漏或回写文档 |
|
||||
| [prompt-code-review.md](prompt-code-review.md) | 审查项目代码质量,覆盖架构、实现、复用、测试、依赖、工程与文档闭环 |
|
||||
|
||||
## 边界说明
|
||||
|
||||
@@ -87,7 +88,7 @@
|
||||
- 是否默认按某个 workflow 执行
|
||||
- 是否以代码、文档、讨论或用户确认为准
|
||||
- 何时必须使用提问工具确认
|
||||
- 删除、重写前是否必须备份
|
||||
- 删除、重写前是否必须记录回退依据;存在 git 仓库时不要创建 `.bak` 文件
|
||||
- 改动后是否必须同步 README、测试、变更文档
|
||||
|
||||
### 4. 计划与执行分离
|
||||
@@ -102,7 +103,7 @@
|
||||
- 执行后必须重新读取受影响对象并复核
|
||||
- 对代码修改要说明测试或验证方式
|
||||
- 对文档修改要检查相关文档之间是否同步一致
|
||||
- 收尾时要列出修改文件、备份文件、验证结果和残留风险
|
||||
- 收尾时要列出修改文件、回退依据、验证结果和残留风险
|
||||
|
||||
## 各章节写法
|
||||
|
||||
@@ -190,14 +191,14 @@
|
||||
|
||||
- 明确顺序执行还是可并行执行
|
||||
- 明确每批执行前是否确认
|
||||
- 明确删除、重写、回退前是否要备份或创建锚点
|
||||
- 明确删除、重写、回退前是否要记录 git diff、创建锚点或在代码目录外备份
|
||||
- 明确执行后最少要复核哪些点
|
||||
|
||||
推荐写法:
|
||||
|
||||
- “逐批执行”或“逐项执行”
|
||||
- “每批执行后重新读取受影响文件并复核”
|
||||
- “若涉及删除或重写,先创建备份文件 `{file}.bak.{timestamp}`”
|
||||
- “若存在 git 仓库,不创建 `.bak` 文件;先记录 `git status` / `git diff` 作为回退依据”
|
||||
|
||||
### 清理 / 收尾
|
||||
|
||||
@@ -206,7 +207,7 @@
|
||||
建议包含:
|
||||
|
||||
- 修改文件清单
|
||||
- 备份文件清单
|
||||
- 回退依据;若实际创建了备份,再列出备份文件清单
|
||||
- 测试 / 构建 / 验证命令与结果
|
||||
- 文档同步摘要
|
||||
- 残留问题、未验证项、待确认事项
|
||||
@@ -238,7 +239,7 @@
|
||||
|
||||
对高风险流程,提示词应提供至少一种回退机制:
|
||||
|
||||
- 备份文件
|
||||
- git diff / 安全锚点 / 代码目录外备份文件
|
||||
- 安全锚点 tag
|
||||
- `abort` 路径
|
||||
- 终止后的现场说明
|
||||
@@ -269,24 +270,24 @@
|
||||
- 把历史变更文档直接当成稳定规范来源
|
||||
- 用抽象表述代替可执行动作
|
||||
- 把多个危险动作打包成一次默认授权
|
||||
- 没有备份、没有锚点、没有终止路径
|
||||
- 没有回退依据、没有锚点、没有终止路径
|
||||
- 只要求“完成修改”,不要求复核和收尾
|
||||
|
||||
## 编写检查清单
|
||||
|
||||
编写完一份提示词后,至少自检以下问题:
|
||||
|
||||
| 检查项 | 说明 |
|
||||
| ---------------- | ------------------------------------------------- |
|
||||
| 目标是否单句明确 | 是否能一眼看出任务对象、目标和范围 |
|
||||
| 约束是否集中 | 全局规则是否只在 `## 约束` 中声明 |
|
||||
| 数据源是否具体 | 是否明确读哪些文档、代码、测试、命令结果 |
|
||||
| 是否先分析再执行 | 是否存在独立的分析和计划阶段 |
|
||||
| 是否有确认节点 | 高风险动作前是否要求提问工具确认 |
|
||||
| 是否有降级路径 | change 不明、规则不明、上下文不足时是否有处理方式 |
|
||||
| 是否可操作 | 是否给出命令、工具、路径或结构化动作 |
|
||||
| 是否可验证 | 执行后是否定义复核或测试方式 |
|
||||
| 是否能收尾 | 是否要求输出修改清单、备份、验证结果、残留风险 |
|
||||
| 检查项 | 说明 |
|
||||
| ---------------- | -------------------------------------------------- |
|
||||
| 目标是否单句明确 | 是否能一眼看出任务对象、目标和范围 |
|
||||
| 约束是否集中 | 全局规则是否只在 `## 约束` 中声明 |
|
||||
| 数据源是否具体 | 是否明确读哪些文档、代码、测试、命令结果 |
|
||||
| 是否先分析再执行 | 是否存在独立的分析和计划阶段 |
|
||||
| 是否有确认节点 | 高风险动作前是否要求提问工具确认 |
|
||||
| 是否有降级路径 | change 不明、规则不明、上下文不足时是否有处理方式 |
|
||||
| 是否可操作 | 是否给出命令、工具、路径或结构化动作 |
|
||||
| 是否可验证 | 执行后是否定义复核或测试方式 |
|
||||
| 是否能收尾 | 是否要求输出修改清单、回退依据、验证结果、残留风险 |
|
||||
|
||||
## 维护原则
|
||||
|
||||
|
||||
Reference in New Issue
Block a user