SuperAPI AI 工具集

comprehensive-review

编程与开发

查看项目

更新于 10-16 05:29

技能介绍

Comprehensive Review 用于在功能实现完成后、考虑合并之前对代码进行系统化审查,依据 7 项标准给出结论,并强制将审查产物发布到对应的 GitHub issue。其核心原则是:自查应在问题到达他人之前先发现问题。

硬性要求:审查产物必须发布到 GitHub issue,这一步由 hooks 强制执行。开始时应声明「I'm performing a comprehensive code review.」。

子智能体选项:如需类似 Claude 的子智能体流程,可运行 codex-subagent code-reviewer 并传入审查范围、issue/PR 编号及关注点。若使用子智能体,则采用其输出与产物;否则按下列步骤执行。

审查产物要求(非可选):在 PR 可创建之前,必须完成全部 7 项标准的审查、记录所有发现、用指定格式将产物作为 issue 评论发布、处理所有发现(修复或创建跟踪 issue 后延期),并将产物更新为「Unaddressed: 0」。review-gate 技能与 PreToolUse hook 会在缺少该产物时阻止 PR 创建。

7 项标准:

  1. 盲点:是否遗漏了什么?检查边界情况(空输入、最大值)、错误路径(外部服务失败、网络问题)、并发(多用户/线程、竞态条件)、状态(调用顺序错误、无效状态)、依赖行为变化。示例:calculateAverage 在空数组时会除以零,需补充校验。
  2. 清晰度/一致性:他人能否理解?检查命名、结构、复杂度、是否符合既有模式、是否有令人意外之处。
  3. 可维护性:能否安全修改?检查耦合、内聚、重复、测试覆盖、可扩展性。
  4. 安全风险:是否可被利用?检查输入校验与净化、认证、授权、数据暴露、注入(SQL、XSS、命令注入)、依赖安全性。若改动了安全敏感文件(auth、api、middleware 等),必须调用 security-review 技能做更深分析。
  5. 性能影响:能否扩展?检查算法复杂度、数据库(N+1、缺索引、全表扫描)、内存(大对象、泄漏)、网络(不必要的请求、大负载)、缓存。
  6. 文档:是否充分记录?检查公共 API、参数、返回值、错误、复杂用法示例、非显然决策的原因。参见 inline-documentation 标准。
  7. 标准与风格:是否遵循项目约定?检查命名、格式、模式、类型(无 any)、包容性语言、IPv6 优先(网络代码默认 IPv6,IPv4 仅限有文档的遗留场景)、lint。参见 style-guide-adherence、strict-typing、inclusive-language、ipv6-first 技能。

审查流程: 步骤 1 准备:用 git diff --name-only HEAD~1 获取改动文件、git diff HEAD~1 获取完整 diff,并用 grep 检查是否包含安全敏感文件;若有匹配,security-review 为强制项。 步骤 2 逐项审查:对 7 项标准逐一审查所有改动代码,记录问题并判定严重级别(Critical/Major/Minor)。 步骤 3 安全检查:若改动了任何安全敏感文件,调用 security-review 技能或运行 codex-subagent security-reviewer,将结果纳入产物并在产物中标记 Security-Sensitive: YES。 步骤 4 记录发现:按 7 项标准列出发现,标注级别并勾选处理状态。 步骤 5 处理全部发现:使用 apply-all-findings 技能处理每个问题;无法修复的用 deferred-finding 技能创建跟踪 issue 并在产物中关联。「延期但无跟踪 issue」不被允许。 步骤 6 发布产物到 issue(强制):用 gh issue comment 将指定格式的审查产物发布为 GitHub issue 评论,内容包含 Worker、Issue、Scope、Security-Sensitive、Reviewed 时间戳、7 项标准结果表、本 PR 已修复发现表、延期发现(含跟踪 issue)表、汇总(Fixed in PR、Deferred、Unaddressed: 0),且 Review Status 必须为 COMPLETE。

严重级别:Critical 为安全、数据丢失、崩溃,合并前必须修复;Major 为显著 bug、性能问题,合并前必须修复;Minor 为风格、清晰度、小改进,宜在合并前修复。

检查清单包括:盲点、清晰度、可维护性、安全(敏感文件强制)、性能、文档、风格均已核查;所有发现已记录;所有发现已处理或带跟踪 issue 延期;产物已按指定格式发布;Unaddressed: 0;Review Status: COMPLETE。

集成关系:本技能由 issue-driven-development 的步骤 9 调用;使用 review-scope(确定审查广度)、apply-all-findings(处理问题)、security-review(安全敏感改动)、deferred-finding(创建跟踪 issue);由 review-gate 与 PreToolUse hook 强制约束;并参考 inline-documentation、strict-typing、style-guide-adherence、inclusive-language、ipv6-first。

限制:资料未提供该技能的收费、价格、平台支持范围或使用效果等信息,暂未提供。