requesting-code-review

请求代码审查

派遣代码审查 Agent（或在可用时调用 /review），在问题逐渐扩大之前发现它们。审查者会获得精心编写的评估上下文——绝不会看到你本次会话的历史记录。这样可以让审查者专注于工作成果，而不是你的思考过程，同时保留你自己的上下文以继续工作。

核心原则： 尽早审查，频繁审查。

何时请求审查

必须：

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

可选但很有价值：

• 遇到瓶颈时（获取新的视角）
• 重构之前（进行基线检查）
• 修复复杂 Bug 后

如何请求

1. 获取 git SHA：

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

2. 派遣代码审查 Agent：

派遣代码审查 Agent（或在可用时调用 /review），并提供以下上下文：

需要填写的占位符：

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

审查请求模板：

Please review the code changes between {BASE_SHA} and {HEAD_SHA}.

What was implemented: {WHAT_WAS_IMPLEMENTED}

Requirements / plan reference: {PLAN_OR_REQUIREMENTS}

Summary: {DESCRIPTION}

Focus on:
- Correctness vs. requirements
- Missing edge cases or error handling
- Test quality (are tests testing real behavior or mocks?)
- Security concerns
- Code clarity and maintainability

Use project's code review template if one exists (e.g., check for a REVIEW_TEMPLATE or similar in the project docs).

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 agent or invoke /review]
  WHAT_WAS_IMPLEMENTED: Verification and repair functions for conversation index
  PLAN_OR_REQUIREMENTS: Task 2 from ai-workspace/plans/deployment-plan.md
  BASE_SHA: a7981ec
  HEAD_SHA: 3df7661
  DESCRIPTION: Added verifyIndex() and repairIndex() with 4 issue types

[Reviewer 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 项）后进行审查
• 获取反馈、应用修改，然后继续

临时开发：

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

危险信号

切勿：

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

如果审查者有误：

• 给出技术理由并提出异议
• 提供能够证明其有效的代码或测试
• 请求澄清