SuperAPI AI 工具集

local-review

编程与开发

查看项目

更新于 10-16 04:38

技能介绍

用途

local-review 用于在本地执行与 GitHub 自动审查动作(Claude / Codex / Pi)在 PR 上运行的相同审查。审查策略存放在 REVIEW.md 中。

该技能的核心设计是:审查必须在全新上下文中运行,而不是在当前会话内联执行。原因在于,如果用户一直在迭代该 diff,主会话已经吸收了他们的推理和辩解,会产生锚定效应并漏掉 CI 能捕获的问题;子代理则像 CI 一样从冷启动开始。

主要能力

  • 确定 PR 范围:若提供了参数,则将其视为 PR 编号或分支;否则从当前分支与 main 的差异中检测。
  • 确认 PR/分支存在(使用 gh pr view <n> 或 git rev-parse <branch>)。
  • 将审查委托给全新上下文的子代理,并提供自包含的提示词。
  • 子代理按 REVIEW.md 的策略进行严重性分级、公共接口检查清单、AGENTS.md 合规性和测试覆盖评估。
  • 支持 --comment 选项,生成适合 GitHub reviews API 的行内评论 JSON 负载。
  • 主会话将子代理的发现原样转达给用户,不重新总结、重新判断或过滤。

使用方式

步骤:

  1. 在主会话中确定 PR 范围(成本低):

    • 若提供了参数,将其视为 PR 编号或分支。
    • 否则从当前分支与 main 检测。
    • 确认 PR/分支存在(gh pr view <n> 或 git rev-parse <branch>)。
  2. 将审查委托给全新上下文的子代理,提示词必须包含:

    • 要审查的 PR 编号或分支名。
    • 先阅读 REVIEW.md 获取策略,再阅读 diff 涉及目录中的 AGENTS.md 文件的指令。
    • 确切的输出格式。
    • 是否请求了 --comment(以便子代理在需要时输出行内评论负载)。
    • 用户提供的任何“Additional reviewer instructions”。
  3. 子代理提示词模板:

Review <PR #N | branch X> against main per the policy in REVIEW.md.

Steps:
1. Read REVIEW.md (repo root) for the full policy: severity triage, public-surface
   checklist, AGENTS.md compliance, test coverage assessment.
2. Read AGENTS.md (repo root) and any AGENTS.md in directories touched by the diff.
3. Get the diff: `gh pr diff <N>` (if PR) or `git diff main...<branch>`.
4. Get context: `gh pr view <N>` (if PR) or `git log main..<branch> --oneline`.
5. Read changed files only when the diff alone is insufficient to validate a finding.
6. Self-validate each finding: "is this definitely a real issue a senior engineer
   would flag?" Discard if uncertain.
7. Output findings in the exact format below. Do not modify any files.

若请求了 --comment,额外输出适合 GitHub reviews API 的行内评论 JSON 数组,每个映射到具体行的发现一条:

[{"path": "...", "line": N, "side": "RIGHT", "body": "[P1] ..."}, ...]
  1. 输出格式:
## Code review

<verdict line per REVIEW.md>

Found N issues:

1. [P0|P1|P2] <description>
   <file_path:line_number>

2. [P0|P1|P2] <description>
   <file_path:line_number>

以共享策略要求的 Test coverage 部分结尾。若未发现问题:

## Code review

Good to merge.

No issues found. Checked for bugs, security, and AGENTS.md compliance.
  1. 接收子代理的发现并原样转达给用户。不要重新总结、重新判断或过滤——全新上下文的意义正是呈现主会话会忽略的内容。

  2. 若请求了 --comment,发布评论:使用以下 gh 命令,以子代理的输出作为正文。主会话负责发布,因为子代理是只读的。

顶层 PR 评论:

gh pr review --comment --body "<summary from subagent>"

针对具体行的行内评论(使用子代理输出的 JSON):

gh api repos/{owner}/{repo}/pulls/{pr}/reviews \
  -f body="<summary>" -f event="COMMENT" -f comments="<json from subagent>"

工具适配

  • Claude Code:使用 Agent 工具,subagent_type: branch-diff-reviewer(只读工具,专为此用途构建)。若不可用,回退到 general-purpose。
  • Codex / Pi:若 CLI 暴露全新会话子代理机制,则使用它;否则告知用户在新的 CLI 会话中运行该技能并停止——在当前会话内联运行会违背初衷。

适用场景

  • 被要求审查代码时(技能描述中标注为 MUST use)。
  • 需要本地复现 GitHub 自动审查动作在 PR 上的审查结果时。
  • 需要检查 bug、安全问题和 AGENTS.md 合规性时。
  • 需要以行内评论形式将审查结果发布到 PR 时。

限制

  • 子代理为只读,发布评论必须由主会话执行。
  • 若 Codex / Pi 的 CLI 不提供全新会话子代理机制,则无法在当前会话内联运行,需改用新的 CLI 会话。
  • 审查策略依赖仓库中的 REVIEW.md,AGENTS.md 合规检查依赖相关目录中的 AGENTS.md 文件。
  • 关于收费、价格、平台支持范围等具体信息,资料中暂未提供。