用途:对一次代码变更做质量审查。审查顺序为正确、安全、承受负载、有测试、够快、精简。它是用户要求的报告,因此需完整给出结果;只列出发现的问题,不修改代码。
审查对象:用户点名的未提交或已暂存改动、分支、PR 链接或文件;未点名时看未提交改动,若没有则看最后一次提交。
主要能力:先读 diff 再读相关代码,包括被改函数的调用方、其调用的函数、测试和 README,追踪数据流入、存储与流出。签名、返回值或行为变化时,grep 所有调用方,因为改动可能破坏未被触碰的代码。从 README、部署配置中找预期负载,据此判断单用户脚本还是多用户多进程场景,并说明假设的负载。
检查内容:缺陷(错误结果、崩溃、边界情况如空值、零、最后一项、取整、时区、调用方被破坏、只修一个调用方而公共函数仍坏);风险(注入、弱随机、密钥、输入校验缺失、数据丢失、错误被吞、写入顺序错误、缺事务);规模问题(先查后写的竞态、每个进程重复做同样工作、内存或列表只增、逐项查询、大数据量 O(n^2)、本应共享的每进程状态);缺失测试(有风险的新逻辑如分支、解析器、金钱、安全、数据写入、缺陷修复,没有会在出错时失败的测试,一个好测试即可,不追求覆盖率);速度(明显变慢才算问题,小优化列为建议);精简(本不该存在或可更小的代码:删除死代码与投机功能;复用仓库已有 helper 并给出路径;用标准库或平台原生能力,避免为几行代码加依赖;避免单实现的抽象和没人设置的配置;合并必须同时改的近似副本;按职责而非行数拆分函数,不做只为缩短函数的拆分)。
报告前核查:每条发现都要有具体案例,说明“这个输入或情形导致这个错误结果”;无案例不写。重读相关行,确认调用方存在、值确实可能为空、代码确实未被使用。标有 shortcut:(或旧写法 ponytail:)并说明其限制的注释视为决策而非发现,除非预期负载已越过该限制。提出能起作用的最小修复,优先删除代码,绝不添加问题不需要的层、框架或配置。不谈风格口味,不用“考虑”,不写含糊担忧。
输出格式:用简单英文,短句、日常词汇,首次出现的技术术语要解释。先写“What this change does:”两三句。然后按 Must fix(缺陷、安全、数据丢失、在预期负载下失效)、Should fix(有风险却无测试、真实变慢、重复、职责混杂、本不该存在的代码)、Nice to have(小幅提速、更短写法)三组列出发现,空组跳过。发现跨组连续编号,便于用户说“修 2 和 5”。每条发现含四部分,每部分一两句:标题(含文件:行号)、这是什么、问题、修复、若跳过会怎样。结尾给 Verdict: Ship 或 Verdict: fix 1 and 3 first;若有精简发现写 Lean: -<N> lines possible;若有重要项无法检查写一行 Not checked;什么都没发现则写“What this change does:”后接“Looks good. Ship.”并一行说明检查了什么。
限制:只列出发现、不修改代码;官方页面未提供收费、价格、安装命令等更多信息。