mcpField
R
requesting-code-review

requesting-code-review

github.com/sickn33测试与质量48.7k459 次安装1 天前更新
代码仓库

关于 requesting-code-review

requesting-code-review 是指导开发者在关键节点请求代码审查的工作流技能。它说明如何提供提交引用和实现背景并处理反馈,同时明确不会授予委派权限或对外披露代码的许可。

主要功能

  1. 01识别必须审查的开发节点
  2. 02收集起始与结束提交 SHA
  3. 03用模板准备审查背景
  4. 04按严重程度处理审查反馈
  5. 05考虑未提交及未跟踪更改

适用场景

  1. 01合并前审查功能改动
  2. 02每项开发任务完成后请求反馈
  3. 03遇到阻碍时获取新视角
  4. 04重构前检查代码基线

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill requesting-code-review

安装后在 Claude Code 中输入/requesting-code-review确认已加载。

附带文件code-reviewer.md

详细介绍

请求代码审查

使用可用且获授权的审查者,在问题逐渐扩大前发现问题。这里提到的 superpowers agent/Task API 是特定于宿主环境的;本指南不授予委派权限,也不授予披露外部代码的许可。

核心原则: 尽早审查,经常审查。

何时请求审查

必须:

  • 在子 Agent 驱动开发中的每项任务完成后
  • 在主要功能完成后
  • 在合并到 main 之前

可选但很有价值:

  • 遇到困难时(获得全新视角)
  • 重构之前(进行基线检查)
  • 修复复杂错误后

如何请求

1. 获取 git SHA:

BASE_SHA=$(git rev-parse HEAD~1)  # or origin/main
HEAD_SHA=$(git rev-parse HEAD)

2. 派遣 code-reviewer 子 Agent:

使用 Task 工具,选择 superpowers:code-reviewer 类型,并填写 code-reviewer.md 中的模板。

占位符:

  • {WHAT_WAS_IMPLEMENTED} - 你刚实现的内容
  • {PLAN_OR_REQUIREMENTS} - 应实现的功能
  • {BASE_SHA} - 起始提交
  • {HEAD_SHA} - 结束提交
  • {DESCRIPTION} - 简要说明

3. 处理反馈:

  • 立即修复严重问题
  • 在继续之前修复重要问题
  • 将次要问题记录下来,稍后处理
  • 如果审查者的意见有误,请说明理由并提出异议

示例

[Just completed Task 2: Add verification function]

You: Let me request code review before proceeding.

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

[Dispatch superpowers:code-reviewer subagent]
  WHAT_WAS_IMPLEMENTED: Verification and repair functions for conversation index
  PLAN_OR_REQUIREMENTS: Task 2 from docs/plans/deployment-plan.md
  BASE_SHA: a7981ec
  HEAD_SHA: 3df7661
  DESCRIPTION: Added verifyIndex() and repairIndex() with 4 issue types

[Subagent returns]:
  Strengths: Clean architecture, real tests
  Issues:
    Important: Missing progress indicators
    Minor: Magic number (100) for reporting interval
  Assessment: Ready to proceed

You: [Fix progress indicators]
[Continue to Task 3]

与工作流集成

子 Agent 驱动开发:

  • 每项任务完成后都要审查
  • 在问题叠加前发现它们
  • 在进行下一项任务前修复问题

执行计划:

  • 每批任务(3 项)完成后审查
  • 获取反馈、应用反馈,然后继续

临时开发:

  • 合并前审查
  • 遇到困难时审查

警示信号

绝不:

  • 因为“这很简单”而跳过审查
  • 忽略严重问题
  • 在重要问题尚未修复时继续
  • 反驳合理的技术反馈

如果审查者有误:

  • 通过技术理由提出异议
  • 展示能够证明代码有效的代码或测试
  • 请求对方澄清

参见随附模板:code-reviewer.md。使用完整解析后的提交 ID,并单独列出未提交和未跟踪的更改;HEAD 到 HEAD 的审查不涵盖这些更改。

何时使用

当任务与概述中所述的工作流或操作相符时,可使用此技能。

限制

  • 仅当任务明确符合上述范围时,才使用此技能。
  • 不要将输出视为环境特定验证、测试或专家审查的替代品。
  • 如果缺少必需的输入、权限、安全边界或成功标准,请停止并请求澄清。

评论

支持 Markdown