AI Agent / 系统课时

执行高信号代码评审

执行高信号代码评审

本课把 Codex 的代码评审从“泛泛找问题”变成可执行的工程检查:先确认变更意图,再沿 diff、调用方和测试寻找可触发的后果,最后只输出有证据、有优先级、能指导修复的结论,而不是堆积风格意见。

学习目标

  • 按正确性、安全性、兼容性和测试覆盖组织评审重点
  • 给 Codex 明确只评审、不擅自修改代码的任务边界
  • 用复现条件和测试证据筛掉低信号或不可行动的 finding

先从“会造成什么后果”开始

高信号 finding 至少要回答四件事:哪段变更触发问题、在什么输入或运行条件下触发、用户或系统会看到什么后果、为什么现有测试没有挡住它。只有代码风格偏好、没有可触发路径的猜测,通常不该占据评审首屏。

评审顺序建议先看正确性与数据破坏风险,再看权限绕过、注入和敏感信息泄露,然后检查 API、配置、数据格式与调用约定是否保持兼容,最后检查关键分支是否有回归测试。优先级来自后果和触发概率,不来自评论数量。

给 Codex 一个可审计的评审任务

在已经打开待评审仓库的 Codex 会话中,可以直接使用下面的主提示词。若团队已有严重性等级,替换示例中的等级名称即可。

text
只做代码评审,不修改文件。先阅读本次 diff、相关调用方和已有测试,再报告问题。
只保留能由代码证据支持的 finding,并按 Blocker、Major、Minor 排序。
每条 finding 必须包含:文件与位置、触发条件、实际后果、证据或复现方式、最小修复方向。
重点检查正确性、安全性、向后兼容性和测试缺口;不要报告纯格式或命名偏好。
如果没有高信号问题,明确说明没有发现需要阻断合并的问题。

这类提示词的关键不是“让模型更严格”,而是固定证据标准和输出结构。评审者仍需验证结论,尤其是涉及权限、并发、迁移和兼容性的判断。

用测试和差异复核 finding

片段示例:以下命令假设当前分支以 origin/main 为基线,并且项目测试可通过 pytest 运行。先看真实变更,再运行测试,不要只根据模型描述判断。

bash
git diff --merge-base origin/main HEAD
python -m pytest -q

预期输出

text
<DIFF>
<PASSED_COUNT> passed in <TIME>s

<DIFF>、<PASSED_COUNT> 和 <TIME> 会随仓库变化。测试全绿并不代表评审结束:如果 diff 新增了一个没有测试覆盖的权限分支,现有测试可能根本没有触发风险路径。

把结论写成可行动的 finding

一条好的结论应尽量短,但必须包含因果链。例如:“Major:permissions.py 新增 return user.is_admin or project.owner_id == user.id,而调用方把 true 解释为允许永久删除。这会让普通项目所有者获得管理员级永久删除能力;用非管理员所有者即可复现。修复时收紧永久删除条件,并补一个拒绝普通所有者的回归测试。”

不要把“可能有安全问题”“建议补测试”单独作为 finding。前者没有触发条件,后者没有说明缺失测试保护了什么行为。若无法指出具体后果,应降级为问题询问或不报告。

什么时候应该阻断合并

会导致数据损坏、权限绕过、敏感信息泄露、崩溃、明显行为回归或破坏既有接口契约的问题,应优先阻断合并。只影响可读性、命名或局部重构质量的建议,通常放在后面,除非它会直接诱发错误。

Codex 的价值在于扩大检查范围,而不是替代负责合并的人。最终评审应做到:结论数量少但命中关键风险,每条都能定位、复现或由代码路径证明,并且修复后可以用测试或明确行为再次验证。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

执行高信号代码评审

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通