SuperAPI AI 工具集

requesting-code-review

编程与开发

查看项目

更新于 11-05 16:18

技能介绍

请求代码审查

该技能用于派发代码审查子代理,在问题扩散之前发现问题。审查者只获得精确构造的上下文用于评估,绝不接触当前会话历史。这样可让审查者专注于工作产物而非你的思考过程,同时保留你自己的上下文以便继续工作。

核心原则:尽早审查,频繁审查。

何时请求审查

强制时机:

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

可选但有价值的时机:

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

如何请求

  1. 获取 git SHA:
BASE_SHA=$(git rev-parse HEAD~1)  # or origin/main
HEAD_SHA=$(git rev-parse HEAD)
  1. 派发代码审查子代理:

派发通用子代理,填写 code-reviewer.md 中的模板。

占位符:

  • {DESCRIPTION} - 你所构建内容的简要说明
  • {PLAN_OR_REQUIREMENTS} - 它应该做什么
  • {BASE_SHA} - 起始提交
  • {HEAD_SHA} - 结束提交
  1. 按反馈处理:
  • 立即修复严重问题
  • 继续前修复重要问题
  • 记录次要问题以备后续处理
  • 若审查者有误则反驳(附理由)

示例

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

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

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

[派发代码审查子代理]

  • DESCRIPTION: Added verifyIndex() and repairIndex() with 4 issue types
  • PLAN_OR_REQUIREMENTS: Task 2 from docs/superpowers/plans/deployment-plan.md
  • BASE_SHA: a7981ec
  • HEAD_SHA: 3df7661

[子代理返回]:

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

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

与工作流集成

子代理驱动开发:

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

执行计划:

  • 每个任务后或自然检查点审查
  • 获取反馈、应用、继续

临时开发:

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

警示信号

绝不:

  • 因“简单”而跳过审查
  • 忽略严重问题
  • 带着未修复的重要问题继续
  • 与有效的技术反馈争辩

若审查者有误:

  • 以技术理由反驳
  • 展示证明其有效的代码/测试
  • 请求澄清

模板见:code-reviewer.md