SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 11-13 20:56

技能介绍

用途

Code Review 是一个代码审查工作流技能,用于规范两件事:如何请求代码审查,以及如何专业地处理审查反馈。其核心原则是“技术严谨优先于社交舒适”,强调在实施任何建议前先做验证。

主要能力

请求审查

技能要求通过 Task 工具派发 review:code-reviewer 子代理,在问题扩散前发现问题。派发时需提供:实现的内容、需求或计划、起始提交(BASE_SHA)与结束提交(HEAD_SHA)、简要描述。

获取 SHA 的命令示例:

BASE_SHA=$(git rev-parse HEAD~1)  # 或 origin/main
HEAD_SHA=$(git rev-parse HEAD)

派发模板位于 plugins/methodology/review/templates/code-reviewer-dispatch.md,审查标准参考 plugins/methodology/review/references/code-review-standards.md。

审查时机

强制审查:子代理驱动开发的每个任务完成后、完成重大功能后、合并到 main 之前。

可选但有价值:卡住时(换视角)、重构前(基线检查)、修复复杂缺陷后。

处理反馈

接收反馈时按六步执行:完整阅读不急于反应;用自己的话复述需求或提问;对照代码库实际情况验证;评估建议是否适合当前代码库;给出技术性确认或有理由的反驳;逐项实现并逐项测试。

禁止的回应包括“你说得完全对”“好观点”“优秀反馈”等表演式认同,以及在验证前就说“我现在来实现”。

反驳与澄清

当建议会破坏现有功能、审查者缺乏完整上下文、违反 YAGNI、对当前技术栈不正确、存在遗留兼容原因或与架构决策冲突时,应基于技术理由反驳。遇到任何不明确的条目,应先停下并请求澄清,避免部分理解导致错误实现。

来源区分

来自人类伙伴的反馈视为可信,理解后实施,范围不清仍需询问;来自外部审查者的反馈,实施前需检查技术正确性、是否破坏现有功能、当前实现原因、跨平台/版本兼容性以及审查者是否了解完整上下文。

YAGNI 检查

当审查者建议“正确实现”某功能时,先在代码库中搜索实际使用情况;若未被使用,可提出按 YAGNI 移除;若被使用,则按要求实现。

确认与纠错

反馈正确时,直接说明修复内容与位置,或直接提交代码,不用表达感谢。若此前反驳有误,应事实性说明“你之前是对的,我检查了 X,它确实会 Y,正在实现”,避免长篇道歉或过度解释。无法验证时应说明限制并询问方向。若难以用语言表达技术异议,可用信号短语“Strange things are afoot at the Circle K”提示人类伙伴深入排查。

实现顺序

多项反馈时,先澄清所有不明确项,再按阻塞问题(破坏、安全)、简单修复(拼写、导入)、复杂修复(重构、逻辑)的顺序处理,逐项测试并确认无回归。

使用方式

技能通过 Task 工具调用 review:code-reviewer 子代理类型;被 workflow:subagent-dev(每个任务后审查)与 workflow:executing-plans(每批后审查)调用;与 core:verification 配合,在请求最终审查前验证各项声明。

适用场景

适用于子代理驱动开发、重大功能完成、合并主分支前,以及卡住、重构前、修复复杂缺陷后等需要引入审查视角的场合。

限制

资料未提供安装命令、收费信息、支持的平台或具体运行环境要求,这些内容暂未提供。