SuperAPI AI 工具集

review-ready-code

测试与质量

查看项目

更新于 10-15 17:19

技能介绍

用途:将已经完成、已验证的实现,转化为便于人工评审的 Git 提交栈,只改变提交历史与呈现方式,不改动最终代码。

主要能力:先锁定源头不可变提交(SOURCE_HEAD)与代码树(SOURCE_TREE),再基于审阅基线分支重建一条线性审阅分支(命名为 <源分支>--review-ready,并使用独立 worktree),把完整 diff 按“一个自包含的概念变更”划分为若干评审单元:相关测试与所验证的行为放在一起,有意义的重构与行为变更分开,生成的机械改动与手写逻辑分开;再按人类理解顺序排序,使每个提交只需依赖已有代码、提交说明和更早的提交即可理解。

必要用法与校验:开始前须明确真实 PR/审阅基线分支(不假定 main 或 master),拉取远端引用,确保实现已提交且工作区干净,并在捕获 SOURCE_HEAD 前跑完实现要求的验证。构造时只使用 SOURCE_HEAD 中已有的内容,逐单元查看暂存 diff 后再提交。交付前校验:审阅 HEAD 的树等于 SOURCE_TREE,且 git diff --exit-code "$SOURCE_HEAD" HEAD -- 成功;每个原始改动路径与 hunk 在栈中恰好出现一次。方式方法上要求每次调用时读取 Google《Small CLs》最新指引,按其判断评审边界,不能只凭记忆。

适用场景:已完成实现需要拆成便于逐条评审的提交栈时;需要按概念而非按文件组织历史时。

限制:树一致性是验收标准,测试通过不能替代;中途提交若导致项目无效需调整边界;不得在构造审阅栈时顺手修复、清理、重命名或重构代码,任何代码改动都应先落在源实现分支;审阅反馈涉及代码改动时,应在源分支修改并重新生成审阅栈,而不是手工变基一串依赖分支。若无法获取该指引来源,应先说明此限制再重排历史。其他细节暂未提供。