git-pr-review

Files (16)

• CHANGELOG.md
• README.md
• SKILL.md
• config.yaml
• community-research-playbook.md · references/
• good-pr-standards.md · references/
• license-checklist.md · references/
• parallel-review-result-template.md · references/
• parallel-vibe-integration.md · references/
• report-template.md · references/
• security-checklist.md · references/
• aggregate_parallel_reviews.py · scripts/
• build_parallel_review_plan.py · scripts/
• common_config.py · scripts/
• prepare_review_job.py · scripts/
• validate_review_artifacts.py · scripts/

SKILL.md (first lines)

# Git PR Review

## 目标

当用户明确要求“review 某个 GitHub PR”“评估某个 pull request 是否值得 merge”“帮我判断这个 PR 怎么处理”时使用。基于用户提供的 GitHub 仓库地址、PR 编号/链接和补充说明，进行只读、证据驱动的 PR 审查：理解 PR 解决的问题、评估方案优劣与局限、默认优先使用内置“好 PR”标准并在必要时联网补充、识别恶意或高风险改动，并输出是否建议 merge 的 Markdown 决策报告。⚠️ 不适用：用户要你直接修改 PR 代码、直接 merge PR、或在本地执行 PR 分支中的不可信代码。

## 流程

### 输入

#### 你需要确认的输入

1. `github_repo`（必需）
   - GitHub 仓库根地址或 `owner/repo`，例如 `https://github.com/owner/repo`
   - 不接受 `issues/`、`pull/`、`tree/` 这类子页面 URL
2. `github_pr`（必需）
   - PR URL、`#123`、`123` 或 `pr-123`
3. `extra_instructions`（可选）
   - 用户已有判断、关注点、禁区、参考材料、团队背景
4. `review_count`（可选）
   - 独立评审次数，默认 5；用户明确指定时以用户要求为准
   - 当你调用 `build_parallel_review_plan.py` 时，把它映射为 `--n <review_count>`
5. `workspace_dir`（可选）
   - 默认 `.bensz-api/task-{yyyymmdd-hhmm}-{简短描述}/git-pr-review/`
6. `report_dir`（可选）
   - 默认当前工作目录（项目根）

### 执行步骤

#### 核心原则

- **只读优先**：默认只能读取 GitHub 页面、API 返回、diff、评论、CI 状态、相关 issue/文档；不要修改源代码。
- **绝不主动 merge**：除非用户明确要求，否则不要执行 merge、rebase、squash、approve、request review 等操作。
- **绝不执行不可信 PR 代码**：不要 `gh pr checkout`、不要运行 PR 分支脚本、不要安装 PR 引入的依赖、不要触发可疑 CI/CD。
- **中间文件隔离**：所有中间文件必须保存在工作目录下的隐藏目录 `.bensz-api/task-{yyyymmdd-hhmm}-{简短描述}/git-pr-review/`；若用户另有指定，才使用用户指定目录。
- **证据驱动**：所有结论都要回到证据，明确引用 diff、评论、CI、issue、社区资料或官方文档。
- **合规不忽略**：如果 PR 触及依赖、vendored 代码、复制粘贴第三方内容、资源资产或许可证文件，必须显式审查 license 风险与兼容性。

#### 标准工作流

##### 1. 初始化隔离工作区

优先使用确定性脚本创建本次评审目录与建议输出文件名：

```bash
python3 git-pr-review/scripts/prepare_review_job.py \
  --repo "https://github.com/owner/repo" \
  --pr "https://github.com/owner/repo/pull/123"
```

脚本会：
- 校验仓库地址与 PR URL 是否属于同一 GitHub 仓库
- 创建本次运行目录（默认 `.bensz-api/task-{yyyymmdd-hhmm}-{简短描述}/git-pr-review/{yyyy-mm-dd-hh-mm}/`）
- 生成 `manifest.json`
- 预创建最小占位文件：
  - `raw/README.md`
  - `notes/user_context.md`
  - `notes/community_good_pr.md`
  - `evidence/key_findings.md`
  - `evidence/missing_items.md`
- 输出建议的最终报告路径（默认项目根）

从这一步开始，所有抓取到的原始材料、分析笔记、临时摘要、命令输出都写入该工作区。

##### 2. 只读获取 PR 证据

优先选择**不会修改仓库状态**的方式读取 PR：

- GitHub 网页 / API / `.patch` / `.diff`
- `gh pr view`、`gh pr diff`、`gh api` 这类只读命令
- 仓库内公开 issue、discussion、相关文档、CI 状态页

建议至少保存下列材料到工作区：

- `raw/pr_meta.*`：标题、作者、状态、标签、基线分支、merge 状态、CI 状态
- `raw/pr_diff.*`：完整 diff 或 patch
- `raw/pr_comments.*`：review comments / discussion（如有）
- `raw/linked_issues.*`：关联 issue / discussion / docs（如有）
- `notes/user_context.md`：用户给的补充信息
- `notes/community_good_pr.md`：关于“好 PR”的社区标准摘记与链接
- `notes/license_review.md`：license / 合规审查笔记（如本次 PR 相关）
- `evidence/missing_items.md`：缺失材料、原因与影响

如果某项拿不到，要在工作区里记录“未获取原因”以及它对结论的影响，而不是静默跳过。

##### 3. 基于 parallel-vibe 做 N 次独立评审（默认 5 次）

目标：
- 使用 `parallel-vibe` 在多个独立 workspace 中做 **N 次彼此独立的 PR 审查**
- 默认 `N=5`
- 每个 thread 必须独立产出 `RESULT.md`
- 最后把多份 `RESULT.md` 聚合为一份统一摘要，再用于最终报告

推荐顺序：

```bash
python3 git-pr-review/scripts/build_parallel_review_plan.py \
  --manifest .bensz-api/task-{yyyymmdd-hhmm}-{简短描述}/git-pr-review/{yyyy-mm-dd-hh-mm}/manifest.json \
  --n 5
```

这里的 `--n` 是 helper script 参数；如果用户说“做 7 次独立评审”，等价于 `review_count=7`，最终在脚本层落成 `--n 7`。

该脚本会在本次 run 目录下生成：
- `parallel_review/input_snapshot/`：供每个 thread 复制的审查输入快照
- `parallel_review/parallel_plan.json`：`parallel-vibe` 的计划文件
- `parallel_review/parallel_review_job.json`：后续运行与聚合所需路径、已解析好的 `parallel-vibe` 脚本路径、固定的 `project_id` 与 `recommended_command`

重要说明：
- 优先直接执行 `parallel_review/parallel_review_job.json` 里的 `recommended_command`，避免手动拼路径或 `project_id`
- 如果 `raw/`、`notes/`、`evidence/` 有变化，必须重新运行 `build_parallel_review_plan.py`，让输入快照和 `project_id` 一起刷新

然后运行：

```bash
# 更推荐直接复制 `parallel_review_job.json` 里的 `recommended_command`
python3 ../parallel-vibe/scripts/parallel_vibe.py \
  --plan-file .bensz-api/task-{yyyymmdd-hhmm}-{简短描述}/git-pr-review/{yyyy-mm-dd-hh-mm}/parallel_review/parallel_plan.json \
  --src-dir .bensz-api/task-{yyyymmdd-hhmm}-{简短描述}/git-pr-review/{yyyy-mm-dd-hh-mm}/parallel_review/input_snapshot \

From huangwb8/skills, MIT.

More from huangwb8/skills