SuperAPI AI 工具集

Requesting Code Review

编程与开发

查看项目

更新于 10-15 14:24

技能介绍

用途

该技能用于在开发过程中派遣代码审查子代理(code-reviewer subagent),在继续推进之前对照计划或需求审查实现,从而在问题扩散前将其捕获。其核心原则是:尽早审查,频繁审查。

何时请求审查

强制场景:

  • 子代理驱动开发中每个任务完成后
  • 完成主要功能后
  • 合并到主分支前

可选但有价值的场景:

  • 卡住时(获取新视角)
  • 重构前(基线检查)
  • 修复复杂缺陷后

如何请求

  1. 获取 git SHA:
BASE_SHA=$(git rev-parse HEAD~1)  # 或 origin/main
HEAD_SHA=$(git rev-parse HEAD)
  1. 派遣 code-reviewer 子代理:

使用 Task 工具,类型为 code-reviewer,填写 code-reviewer.md 中的模板。

占位符:

  • {WHAT_WAS_IMPLEMENTED} - 你刚刚构建的内容
  • {PLAN_OR_REQUIREMENTS} - 它应该做什么
  • {BASE_SHA} - 起始提交
  • {HEAD_SHA} - 结束提交
  • {DESCRIPTION} - 简要摘要
  1. 根据反馈行动:
  • 立即修复 Critical 问题
  • 在继续前修复 Important 问题
  • 记录 Minor 问题以便后续处理
  • 如果审查者有误,可基于理由进行反驳

示例

[刚完成任务 2:添加验证函数]

你:让我在继续前请求代码审查。

BASE_SHA=$(git log --oneline | grep "Task 1" | head -1 | awk '{print $1}')
HEAD_SHA=$(git rev-parse HEAD)

[派遣 code-reviewer 子代理]

  • WHAT_WAS_IMPLEMENTED: 会话索引的验证与修复函数
  • PLAN_OR_REQUIREMENTS: docs/plans/deployment-plan.md 中的任务 2
  • BASE_SHA: a7981ec
  • HEAD_SHA: 3df7661
  • DESCRIPTION: 添加了 verifyIndex() 和 repairIndex(),包含 4 种问题类型

[子代理返回]:

  • 优点:架构清晰,有真实测试
  • 问题:
    • Important:缺少进度指示器
    • Minor:报告间隔使用魔法数字(100)
  • 评估:可以继续

你:[修复进度指示器] [继续任务 3]

与工作流的集成

子代理驱动开发:

  • 每个任务后审查
  • 在问题累积前捕获
  • 在进入下一任务前修复

执行计划:

  • 每批(3 个任务)后审查
  • 获取反馈、应用、继续

临时开发:

  • 合并前审查
  • 卡住时审查

危险信号

绝不:

  • 因为“很简单”而跳过审查
  • 忽略 Critical 问题
  • 在 Important 问题未修复的情况下继续
  • 与有效的技术反馈争辩

如果审查者有误:

  • 基于技术理由反驳
  • 展示证明其可用的代码/测试
  • 请求澄清

模板见:skills/collaboration/requesting-code-review/code-reviewer.md