mcpField
R
requesting-code-review

requesting-code-review

github.com/nickcrew测试与质量6272 次安装18 周前更新
代码仓库

关于 requesting-code-review

面向开发者的代码审查工作流技能,帮助在改动继续推进或合并前发起审查。内容说明如何向 code-reviewer 子 Agent 提供提交 SHA 和背景,并按严重程度处理反馈。

主要功能

  1. 01代码审查时机指引
  2. 02获取提交 SHA
  3. 03派发 code-reviewer 子 Agent
  4. 04审查请求模板字段
  5. 05按严重程度处理反馈

适用场景

  1. 01审查子 Agent 开发中的每项任务
  2. 02合并前检查主要功能
  3. 03遇到阻碍时获取不同视角

安装

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

$npx skills add https://github.com/nickcrew/claude-cortex --skill requesting-code-review

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

附带文件code-reviewer.md

详细介绍

请求代码审查

派遣 code-reviewer 子 Agent,在问题扩大之前发现它们。

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

何时请求审查

必须:

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

可选但很有价值:

  • 遇到瓶颈时(获取新的视角)
  • 重构之前(检查基准状态)
  • 修复复杂 Bug 后

如何请求

1. 获取 Git SHA:

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

2. 派遣 code-reviewer 子 Agent:

使用 Task 工具,指定 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 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 项)完成后审查
  • 获取反馈、落实修改,然后继续

临时开发:

  • 合并之前审查
  • 遇到瓶颈时审查

警示信号

切勿:

  • 因为“很简单”而跳过审查
  • 忽略严重问题
  • 对未修复的重要问题置之不理,继续推进
  • 反驳合理的技术反馈

如果审查者有误:

  • 提出异议并给出技术理由
  • 展示能够证明其可行的代码或测试
  • 请求对方说明

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

评论

支持 Markdown