SuperAPI AI 工具集

pr-review

编程与开发

查看项目

更新于 10-16 07:15

技能介绍

用途:使用本地工作目录对 pull request 进行专家级审查,重点关注代码质量、缺陷预防和架构改进,输出简洁、可执行的反馈。

主要能力与流程:

  1. 获取 PR 信息:运行 scripts/fetch_pr_metadata.sh <PR_NUMBER> [REPO],返回包含 number、title、headRefName、baseRefName、headRepository、body、comments、author、url 的 JSON。若不知道 PR 编号,可用 gh pr list --state open 列出开放的 PR。
  2. 准备工作目录:运行 scripts/setup_pr_workspace.sh <OWNER> <REPO> <PR_BRANCH> <BASE_BRANCH>,脚本会按需克隆仓库、抓取更新(含基分支)、检出 PR 分支并拉取最新改动。工作目录位于 $HOME/claudework/pr-reviews/<repo-name>,后续文件操作使用该目录下的相对路径。
  3. 检查改动:运行 scripts/get_pr_diff.sh <REPO_NAME> <BASE_BRANCH> <PR_BRANCH> 获取 diff,关注修改行、涉及的文件模式和改动范围。脚本始终对比 refs/remotes/origin/<BASE_BRANCH>,以避免本地分支过期造成误报;也可用 gh pr diff <PR_NUMBER>。
  4. 阅读完整上下文:必要时用 read_file 读取绝对路径下的完整文件,如 $HOME/claudework/pr-reviews/<repo-name>/<file-path>;也可切换分支比较新旧版本。
  5. 架构分析:依据 references/architecture-principles.md 检查三层架构遵循情况,识别端点/路由中的业务逻辑、业务逻辑中的外部 API 调用、单函数多职责、有状态服务等问题,并检查 DRY、错误处理、命名清晰度和测试覆盖。
  6. 撰写审查:将 markdown 审查保存到 PROJECT_ROOT/pr-reviews/<repo-name>-<pr-number>.md(必要时创建目录)。结构包含标题、仓库/PR/分支/作者/日期、Summary、Architectural Review、Code Quality Issues、Recommendations、Verdict(Approve / Request Changes / Needs Discussion)。反馈要求简洁、具体(引用代码和行号)、有建设性并优先关注影响大的缺陷与架构问题。

适用场景:当用户要求“review a PR”“check pull request”或引用某个 pull request 时使用。

限制:资料中未提供安装方式、依赖前提、支持的代码托管平台范围、收费或价格信息,也未说明除 gh CLI 与 git 之外的工具要求;以上暂未提供。