SuperAPI AI 工具集

requesting-code-review

编程与开发

查看项目

更新于 10-15 09:44

技能介绍

用途

requesting-code-review 是一个用于在软件开发过程中请求代码审查的技能。它的核心原则是“尽早审查、频繁审查”,目的是在问题扩散之前发现并修复它们。该技能通过派发 superpowers:code-reviewer 子代理来执行代码审查,帮助开发者验证工作是否满足需求。

主要能力

该技能提供了明确的审查时机指导、请求审查的具体步骤,以及处理审查反馈的规则。它能够帮助团队在开发流程中建立一致的代码审查习惯,减少问题累积。

使用方式

何时请求审查

必须审查的时机:

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

可选但有价值的时机:

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

如何请求审查

  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} - 简要总结
  3. 根据反馈采取行动:

    • 立即修复严重问题
    • 在继续之前修复重要问题
    • 记录次要问题以便后续处理
    • 如果审查者有误,以理由反驳

示例

[刚完成任务 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/plans/deployment-plan.md 的任务 2 BASE_SHA: a7981ec HEAD_SHA: 3df7661 DESCRIPTION: 添加了 verifyIndex() 和 repairIndex(),包含 4 种问题类型

问题: 重要:缺少进度指示器 次要:报告间隔的魔法数字(100) 评估:可以继续

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

与工作流的集成

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

限制与注意事项

红旗警告——永远不要:

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

如果审查者有误:

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

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