SuperAPI AI 工具集

do-review

测试与质量

查看项目

更新于 10-16 04:06

技能介绍

用途

do-review 是一个评审者侧的合并风险评估技能,用来检查 GitHub Pull Request、分支 diff 以及本地工作区 diff。它的核心立场是把变更当作一个带有预期结果的提案,而不是一堆文件的堆叠,因此评审时优先关注:目标达成情况、正确性、安全性、数据安全、契约兼容性、测试证据以及已有的评审状态。

主要能力

  • 支持 GitHub PR 模式:通过 PR 编号/URL(如 owner/repo#123、gh pr view N)进行评审,可获取 PR 正文、关联 issue、CI、正式评审、行内评论线程和机器人评论等上下文。
  • 支持本地 diff 模式:对本地 git 仓库的 base/head 引用(如 origin/main...HEAD)或暂存/未暂存 diff 进行评审,可获取提交历史、diff 和文件上下文。
  • 文件聚类:按关注点(数据/迁移、安全/认证、API/路由/契约、核心或业务逻辑、前端/用户可见行为、基础设施/配置/文档、测试与类型定义等)对变更文件分组,优先深入最高风险的聚类。
  • 已有评审状态读取:获取正式评审、行内评论线程、PR 对话评论、机器人/AI/扫描器/依赖评论,并分类为 resolved、active、outdated、conversation-level、unavailable,避免与机器人重复。
  • 目标验证:检查端到端 happy path、失败与错误路径、描述的行为是否出现在 diff 中、是否有未说明的高风险额外范围、是否缺少测试/文档/配置/消费者/类型定义/迁移等支撑变更。
  • 按聚类评审:按顺序应用安全性/认证、正确性与边界情况、数据完整性与向后兼容、API 契约与校验、现实性能影响、针对变更行为的测试、仅在影响安全或理解时的可维护性等维度。
  • 跨切面扫描:识别协调失败,例如 schema 变了但 API 或消费者没变、API 变了但测试/文档/客户端/UI 没变、新端点或页面没有认证、新环境变量或依赖没有部署/配置更新等。
  • 严重度校准与输出:使用 🔴 Blocker、🟡 Important、🟢 Suggestion、💡 Question、🎯 Praise 五档,并给出 ✅ Approve、💬 Comment、🔄 Request Changes 的裁决梯度。

使用方式

  • 用户提示模式:输入 PR 编号/URL、分支对比、本地 diff 或工作区变更,默认在聊天中输出 Markdown 评审;除非请求明确要求提交、发布、发表或评论,否则不对 GitHub 做变更。
  • 技能工具模式:输入 PR 目标、本地对比或候选发现,输出带证据和严重度的结构化评审;除非调用方明确要求,否则不做变更。
  • 斜杠命令/编排模式:orchestrate-codex 评审模式,可传入分支 diff 加一个 codex exec 评审候选项,输出机器可读的逐项决策 JSON,形如:
{
  "decision": "accepted|rejected|ambiguous",
  "severity": "blocker|important|suggestion|question",
  "evidence": ["file:line"],
  "rationale": "Why the item does or does not survive review.",
  "intended_fix_shape": "Optional only for accepted items."
}
  • 该技能提供脚本辅助:scripts/parse-pr.sh 用于重复性的 GitHub PR 上下文收集,scripts/cluster-files.sh 用于初始聚类映射,使用方式参考对应 .md 文档。

适用场景

  • 评审 PR:review PR #123、review this PR、review github.com/owner/repo/pull/N。
  • 合并就绪检查:is this safe to merge?、merge readiness check、give this PR a review。
  • 走查 diff:walk this diff、review main...feature-branch、review origin/main...HEAD。
  • 本地变更评审:review my staged changes、review my working tree、review this local diff。
  • 对 codex-review 发现进行逐项验证。
  • 已有 CodeRabbit/Copilot/Greptile 等评论时,判断还有什么需要标记。
  • 对变更文件聚类并标记最高风险项,或面对大量变更文件时确定优先查看顺序。

限制

  • 不用于作者侧交接(如开 PR、写自评正文、提交脏工作树),那应使用 ask-review。
  • 不用于对自己收到的评审反馈做分诊(人类 PR 评论、已发布的机器人评论、markdown 审计文档、多评审者流),那应使用 evaluate-code-review。
  • 不用于仓库状态清理(陈旧分支、多工作树、批量 PR 整理),那应使用 run-repo-cleanup。
  • 不用于运行时调试(没有 diff 可判断的失败日志、复现、行为诊断),那应使用 do-debug。
  • 不做纯样式或格式化反馈,应交由 lint/formatter 自动化处理。
  • 评审前必须先在一行内指明确切的对比目标;若无法命名目标,应停止并请求缺失目标后再评审。
  • 若证据不完整,应降级为 💡 Question 而非断言缺陷。
  • 关于收费、价格、平台支持等具体信息,资料未提供。