baa-conductor

commit

e5c3def

parent

5a967db

author

codex@macbookpro

date

2026-03-30 17:31:31 +0800 CST

docs: add review template

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