baa-conductor

review-template.md

  1# 代码审查模板
  2
  3## 用途
  4
  5这个模板用于对 AI 执行的任务进行代码审查。适用于任何仓库中按任务文档完成的开发工作。
  6
  7审查目标：
  8
  9- 验证代码是否满足任务文档的验收标准
 10- 发现潜在 bug、边界问题、反向用例
 11- 给出可执行的改进建议
 12- 确保口径一致性（指标定义、公共逻辑复用等）
 13
 14## 使用方式
 15
 16审查者（Claude 或人）在新对话中：
 17
 181. 读取目标仓库最新提交
 192. 对照任务文档的验收标准逐项检查
 203. 按本模板结构输出 review
 214. 写入仓库 `reviews/` 目录并提交到 main
 22
 23推荐提示词：
 24
 25- `读取 <仓库路径> 最新提交，review，给出建议和可能存在的 bug、边界、反向用例`
 26- `重新读最新提交，review，写入 reviews 目录并提交推送`
 27
 28## 模板正文
 29
 30下面是可直接复制的结构。生成新 review 时，把尖括号占位内容替换掉即可。
 31
 32```md
 33# Review: <任务标题>
 34
 35- 审查者：<审查者名称，如 Claude Opus 4.6>（必填）
 36- 审查日期：<YYYY-MM-DD>（必填）
 37- 关联任务：`<Task ID>`（必填，如 Task 04）
 38- 任务文档：`<任务文档绝对路径>`（必填）
 39- 审查范围：`<起始commit>..<结束commit>`（<N> commits）
 40- 执行者：<执行任务的 AI 名称，如 Codex (GPT-5)>
 41- 关联文档：
 42  - `<相关 plan / checklist / 上游任务文档路径>`
 43  - `<相关 review 路径（如果是 follow-up）>`
 44
 45## 涉及文件
 46
 47- `<文件路径>`（新增 / 修改，<行数> 行）
 48- `<文件路径>`（新增 / 修改，<行数> 行）
 49
 50## 实验结论
 51
 52<用表格或简要文字总结核心结果>
 53
 54## 做对的事
 55
 561. <值得肯定的设计或实现决策>
 572. <值得肯定的设计或实现决策>
 58
 59## 问题
 60
 61按严重程度排列：高 > 中等 > 低。
 62
 63### 高：<问题标题>
 64
 65<问题描述：是什么、在哪里（文件:行号）、为什么是问题>
 66
 67建议：<具体修复方案>
 68
 69### 中等：<问题标题>
 70
 71<问题描述>
 72
 73建议：<具体修复方案>
 74
 75### 低：<问题标题>
 76
 77<问题描述>
 78
 79## 反向用例
 80
 81列出可能推翻或削弱当前结论的场景：
 82
 83### 1. <场景名>
 84
 85<如果 X 条件改变，当前结论会怎样>
 86
 87### 2. <场景名>
 88
 89<如果 Y 条件改变，当前结论会怎样>
 90
 91## 验收对照
 92
 93| 验收标准 | 是否满足 |
 94|---------|---------|
 95| <任务文档中的验收标准 1> | 通过 / 未通过 |
 96| <任务文档中的验收标准 2> | 通过 / 未通过 |
 97
 98## 建议
 99
100按优先级排列的可执行改进项：
101
1021. <最重要的改进>
1032. <次重要的改进>
1043. <可选改进>
105```
106
107## 命名规则
108
109Review 文件统一放在仓库的 `reviews/` 目录下，命名格式：
110
111```
112<日期>_<任务编号>_<任务简称>_review.md
113```
114
115示例：
116
117- `2026-03-30_task03_alpha_delta_separation_review.md`
118- `2026-03-30_task04_t9_irreversibility_review.md`
119- `2026-03-30_followup_task_split_review.md`
120
121## 审查要点清单
122
123写 review 时，至少检查以下维度：
124
125### 正确性
126
127- 代码逻辑是否与任务文档描述一致
128- 公式实现是否与文档定义一致
129- 公共逻辑是否正确复用（而不是各自重新实现）
130
131### 实验设计
132
133- 对照组是否公平（起点、输入、参数一致）
134- 结论是否依赖未声明的隐含假设
135- 超参数选择是否有理论依据或敏感性验证
136- 单 seed vs 多 seed，样本量是否足够
137
138### 边界与鲁棒性
139
140- 边界 case（极端参数、零值、单步波动）是否处理
141- 阈值判据是否有理论依据
142- 结论对超参数是否过度敏感
143
144### 反向用例
145
146- 什么条件下当前结论会被推翻
147- 是否存在实验设计本身放大了预期结果的正反馈
148- 是否有未测试但物理上合理的对立场景
149
150### 口径一致性
151
152- 同名指标在不同文件中定义是否一致
153- 新引入的定义是否回写到清单或文档
154- 与上下游任务的接口是否对齐
155
156### 文档完整性
157
158- 任务文档状态是否更新
159- 执行记录是否填写
160- 遗留风险是否记录