SuperAPI AI 工具集

requesting-code-review

编程与开发

查看项目

更新于 10-15 14:26

技能介绍

用途

该技能用于在开发过程中调度 code-reviewer 子代理,对照计划或需求审查代码实现,以便在问题级联扩散之前将其捕获。其核心原则是:尽早审查,频繁审查。

主要能力

  • 明确何时应请求代码审查,分为强制性和可选但有价值两类。
  • 提供快速开始步骤,包括获取 git SHA、调度 code-reviewer 子代理、以及根据反馈采取行动。
  • 定义审查反馈的严重程度分级及对应处理方式。
  • 说明如何与不同开发工作流集成。
  • 提供对审查意见进行技术性反驳的指导。
  • 列出常见错误,区分“绝不”和“始终”应做的行为。

使用方式

何时请求审查

强制性场景:

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

可选但有价值的场景:

  • 遇到困难时(获取新视角)
  • 重构前(基线检查)
  • 修复复杂 bug 后

快速开始

  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 Template 中的模板。

必需占位符:

  • {WHAT_WAS_IMPLEMENTED} - 你刚刚构建的内容
  • {PLAN_OR_REQUIREMENTS} - 它应该做什么
  • {BASE_SHA} - 起始提交
  • {HEAD_SHA} - 结束提交
  • {DESCRIPTION} - 简要总结
  1. 根据反馈采取行动:
严重程度 行动
Critical 立即修复,不要继续
Important 在下一个主要任务前修复
Minor 记录待后续处理,可以继续

详见严重程度指南。

与工作流集成

  • 子代理驱动开发:每个任务后审查;在问题复合之前捕获;在进入下一个任务前修复。
  • 执行计划:每批(3 个任务)后审查;获取反馈、应用、继续。
  • 临时开发:合并前审查;遇到困难时审查。

对审查意见进行反驳

如果审查者有误:

  • 用技术理由进行反驳
  • 展示证明其可行的代码/测试
  • 引用计划需求
  • 请求澄清

详见反驳示例。

常见错误

绝不:

  • 因为“很简单”而跳过审查
  • 忽略 Critical 问题
  • 在 Important 问题未修复的情况下继续
  • 没有技术依据地争论

始终:

  • 在审查请求中提供完整上下文
  • 立即修复 Critical 问题
  • 用技术理由记录分歧
  • 修复 Critical 问题后重新审查

示例

需要示例?参见 Review Examples & Workflows,其中包含:

  • 完整的审查输出示例
  • 好的与坏的审查请求对比
  • 不同场景的审查工作流
  • 如何根据不同严重程度采取行动
  • 何时以及如何反驳

需要模板?参见 Code Reviewer Template 获取完整的子代理调度模板。

限制

资料中未提供关于该技能的具体平台限制、收费模式、价格或效果保证等信息。