SuperAPI AI 工具集

requesting-code-review

编程与开发

查看项目

更新于 10-16 14:20

技能介绍

requesting-code-review 是 zed-industries/superpowers 项目提供的一个代码审查请求技能,其描述为“在完成任务、实现大型功能或合并到主分支之前,验证工作是否满足需求时使用”。

用途 该技能用于在开发流程的关键节点请求代码审查,以便在问题级联放大之前发现它们。它的核心原则是:尽早审查,频繁审查。

主要能力

  • 派发 superpowers:code-reviewer 子代理来审查代码。
  • 向审查者提供精心构造的上下文,而非当前会话的历史记录,使审查者专注于工作成果而非思考过程,同时保留自身的上下文以便继续工作。
  • 通过模板文件 code-reviewer.md 组织审查请求。

何时请求审查 强制场景:

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

可选但有价值的场景:

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

使用方式

  1. 获取 git SHA: BASE_SHA=$(git rev-parse HEAD~1) # 或 origin/main HEAD_SHA=$(git rev-parse HEAD)

  2. 派发 code-reviewer 子代理: 使用 Task 工具,类型为 superpowers:code-reviewer,填写 code-reviewer.md 中的模板。 占位符包括:

  • {WHAT_WAS_IMPLEMENTED} - 刚构建的内容
  • {PLAN_OR_REQUIREMENTS} - 它应该做什么
  • {BASE_SHA} - 起始提交
  • {HEAD_SHA} - 结束提交
  • {DESCRIPTION} - 简要摘要
  1. 处理反馈:
  • 立即修复关键问题
  • 在继续前修复重要问题
  • 记录次要问题以便后续处理
  • 若审查者有误,附理由反驳

示例 [刚完成 Task 2:添加验证函数]

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

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

[派发 superpowers:code-reviewer 子代理] WHAT_WAS_IMPLEMENTED: 对话索引的验证与修复函数 PLAN_OR_REQUIREMENTS: docs/superpowers/plans/deployment-plan.md 中的 Task 2 BASE_SHA: a7981ec HEAD_SHA: 3df7661 DESCRIPTION: 添加了 verifyIndex() 和 repairIndex(),包含 4 种问题类型

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

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

与工作流的集成 子代理驱动开发:

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

执行计划:

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

临时开发:

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

危险信号 绝不要:

  • 因为“很简单”而跳过审查
  • 忽略关键问题
  • 带着未修复的重要问题继续
  • 对有效的技术反馈进行争辩

如果审查者有误:

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

模板位置:requesting-code-review/code-reviewer.md