SuperAPI AI 工具集

review-process

编程与开发

查看项目

更新于 10-13 15:31

技能介绍

Code Review Process

用途

该技能提供一套分步工作流,用于开展全面的代码审查(code review)。它把一次评审拆解为可执行的阶段,帮助审查者有序推进,避免遗漏关键检查点。

主要能力:分步审查流程

1. 理解背景(Understand Context)

  • 阅读 PR 描述和关联议题(linked issues)。
  • 理解正在解决什么问题以及为什么需要解决。
  • 检查该方案是否此前已有讨论(设计文档、RFC、议题讨论串)。

2. 高层浏览(High-Level Pass)

  • 查看文件列表——改动范围是否符合所述目标?
  • 检查是否混入了无关改动(这些应拆分为独立 PR)。
  • 审视整体架构:该方案是否契合代码库的既有模式?

3. 详细审查(Detailed Review)

  • 按逻辑顺序而非文件顺序走查代码。
  • 从入口点开始,沿着数据流追踪。
  • 对每处改动,按审查维度评估(正确性、架构、命名、测试、错误处理、安全性)。
  • 记录发现的问题,包含严重程度、位置、问题与建议。

4. 测试审查(Test Review)

  • 是否测试了应当测试的内容?
  • 测试是否覆盖正常路径与错误路径?
  • 测试检验的是行为(what)还是实现(how)?
  • 如果有人修改实现,测试能否捕获回归?

5. 归纳反馈(Synthesize Feedback)

  • 按严重程度对发现的问题分组。
  • 将关键问题放在最前面。
  • 给出总体结论:批准(approve)、请求修改(request changes)或评论(comment)。
  • 若请求修改,明确哪些是阻塞项、哪些是可选项。

6. 后续跟进(Follow-Up)

  • 及时复审已处理的反馈。
  • 验证修复是否真正解决问题(而非表面处理)。
  • 阻塞问题解决后即批准——复审时不要添加新的非阻塞反馈。

适用场景

适用于需要对 PR 或代码改动进行系统化评审的团队与个人开发者,尤其是在需要统一评审标准、明确阻塞与非阻塞问题、并保持复审节奏的开发协作流程中。

限制

资料中未提供关于平台依赖、收费、价格或具体集成方式的说明,相关内容暂未提供。