# GitHub PR 审核工作流程使用 agynio/gh-pr-review 中的“gh-pr-review”扩展来完成审查、处理反馈和解决 GitHub 拉取请求中的线程的工作流程。 **有关 gh-pr-review 文档，请参阅：** ** ** ## 安装 **安装 gh-pr-review 扩展（如果尚未安装）：** gh 扩展安装 agynio/gh-pr-review **验证安装：** gh 预审--帮助 ** ** ## 工作流程概述公关审查请求 ├─ 获取 PR 号/repo 上下文 ├─ 列出所有评论主题 ├─ 分析反馈和评论 ├─ 验证每条评论是否适用并解释决定 ├─ 在代码中实施修复 ├─ 运行测试（单元+lint+类型检查） ├─ 回复所有开放的评论主题并附上解释 ├─ 最多等待5分钟进行跟进 ├─ 解决审核主题（或解决后续问题） └─ 提交并推送更改 ** ** ## 分步过程 ### 1\.获取公关背景 **获取当前公关详细信息：** # 获取PR号 gh pr 查看 --json 数字 # 获取 PR 标题和状态 gh pr view --json 标题、作者、状态、评论 # 获取存储库信息（用于 gh pr-review） git 远程获取 url 来源 **输出：** PR 编号（例如，``）和存储库（例如，``） ** ** ### 2\.列出审核主题 **列出所有评论线程（活动的和过时的）：** # 来自 PR 根目录 gh pr-审查线程列表 --pr --repo # 示例： gh pr-审查线程列表 --pr --repo **回复格式：** [ { "threadId": "", “已解决”：假， “更新时间”：“2026-01-17T22：48：36Z”， "path": "path/to/file.ts", “行”：42， “已过时”：假 } ] **关键字段：** * `threadId`: 用于解析/回复的 GraphQL 节点 ID * `isResolved`: 当前状态 * `isOutdated`：代码自评论后是否已更改 * `path` \+ `line`: 文件位置如果所有评论线程均已解决或不存在，请搜索正常评论并分析它们： gh pr view --comments --json 作者、评论、评论 ** ** ### 3\.阅读并分析反馈 **通过 GitHub API 获取评论意见：** # 获取PR的所有评论 gh api repos///pulls//comments # 使用 jq 以获得更清晰的输出 gh api repos///pulls//comments \ --jq '.[] | {id，正文，作者，created_at，行，路径}' **阅读提到的具体文件：** # 阅读文件上下文以了解反馈猫<路径> # 或使用读取工具 **对反馈进行分类：** * **高优先级**：安全问题、错误、重大更改 * **中优先级**：代码质量、可维护性、测试覆盖率 * **低优先级**：风格、文档、必备品 **更改代码之前验证适用性（必需）：** * 确认每条注释准确且与当前代码相关。 * 如果建议不正确、过时或在此代码库中没有意义，**回复并详细解释**为什么未实现该建议。 * 不要仅仅因为一项变更耗时而跳过它——要么实施它，要么清楚地解释为什么不应该这样做。 ** ** ### 4\.实施修复 **编辑评论中提到的文件：** # 使用编辑工具或 bash 编辑 <文件路径> <旧字符串> <新字符串> **遵循存储库约定：** * 检查相似文件中的现有模式 * 遵循 AGENTS.md 指南 * 保持代码风格的一致性 * 添加/更新新逻辑的测试 ** ** ### 5\.验证更改（关键） **在回复之前始终运行测试：** # 运行项目测试发髻运行测试 # 或特定的测试套件面包运行测试：单元包子运行测试：单位：手表包子运行测试：e2e **运行类型检查：** 包子运行类型检查 # 或 tsc--noEmit **运行 linting：** 包子跑绒毛 # 或埃斯林特 **验证所有通过：** * ✓ 无 TypeScript 错误 * ✓ 无 ESLint 警告/错误 * ✓ 所有单元测试均通过 * ✓ E2E 测试通过（如果相关） ** ** ### 6\.提交并推送更改 **暂存并提交更改：** # 检查状态 git 状态 # 暂存修改后的文件 git add <文件> # 提交时带有明确的信息 git commit -m "<类型>(<范围>): <描述> # 示例： git commit -m“重构（电子邮件）：集中名称逻辑并改进清理 - 将 RESEND_FROM_NAME 常量提取到 lib/emails/from-address.ts - 替换 lib/auth.ts 和 app/actions/contact.ts 中的重复逻辑 - 改进 formatFromAddress 清理（RFC 5322 字符） - 添加其他清理模式的测试用例” **推送到远程：** git 推送 **验证工作树：** git 状态 # 应该显示：“没有什么可提交的，工作树干净” ** ** ### 7\.回复评论主题 **回复修复说明：** gh pr-审稿评论回复\ --pr \ --repo <所有者/REPO> \ --线程 ID <线程 ID> \ --body "<你的解释>" **回复的最佳做法：** * 确认反馈 * 解释一下改变了什么 * 参考具体提交（如果相关） * 简洁但清晰 * 对代码片段使用代码围栏 **回复示例：** gh pr-审稿评论回复\ --pr \ --repo <所有者/REPO> \ --线程 ID <线程 ID> \ --body "$(猫 <<'EOF' @审稿人感谢您的反馈！我已经解决了您的建议： 1. 在相关模块中应用所请求的重构 2.删除了受影响的调用站点中的重复逻辑 3. 改进卫生处理以符合项目预期 4. 添加/更新了新行为的测试在 abc1234 中提交的更改，所有测试均通过。 EOF ）” **注意：** 对多行正文使用 heredoc 以避免 shell 转义问题。 **注意：** 在推送更改后，始终以“@reviewer”（例如“@gemini-code-assist ...”或“@greptile ...”）开始回复。可能有多个审阅者，因此请始终查找该评论来自哪个审阅者的确切评论。如果这是正常评论而不是评论（请参阅步骤 2），您可以使用以下内容来回答： gh pr 评论 --body "$(cat <<'EOF' @reviewer … <同上> EOF ）” 如果合适的话，您也可以对评论做出反应。 **首先回复所有打开的线程：** 1. 回复每一条公开评论，说明您所做的**或**未完成的原因。 2. 只有在发布所有回复后，才进入等待/解决阶段。 ** ** ### 8\.等待后续并解决线程 **实施修复、推送提交并回复所有开放评论后，最多等待 5 分钟进行后续处理：** # 等待审稿人回复一分钟睡眠 60 # 重新检查新回复或新话题 gh pr-审查线程列表 --pr --repo 执行此步骤最多 5 次，等待最多 5 分钟。 **如果有后续提示，请解决它（步骤 3-7），然后解决。** **如果有确认，则解决该线程：** gh 预审线程解决 \ --pr \ --repo <所有者/REPO> \ --线程 ID <线程 ID> **回应：** { "thread_node_id": "PRRT_kwDOQkQlKs5p24lu", “is_resolved”：正确 } **批量解析多个线程：** # 首先解决过时的线程 gh pr-review 线程解析 --pr --repo --thread-id gh pr-review 线程解析 --pr --repo --thread-id # 回复后解析活动线程 gh pr-review 线程解析 --pr --repo --thread-id **策略：** 1. 解决过时的线程 (isOutdated: true) - 无需回复 2. 回复解释修复（或未更改）的活动线程 3. 等待最多 5 分钟以获得回复 4. 确认或无响应后解决活动线程 ** ** ### 9\.验证所有线程已解决 **最终检查：** gh pr-审查线程列表 --pr --repo **预期输出：** 所有线程均显示 `isResolved: true` ** ** ## 完整的示例工作流程 # 1. 获取公关背景 gh pr 查看 --json 数字 git 远程获取 url 来源 # 2. 列出评论主题 gh pr-审查线程列表 --pr --repo # 3. 阅读评论和文件 gh api repos///pulls//comments --jq '.[] | {id，正文，路径，行}' cat 路径/to/file.ts # 4. 实施修复编辑path/to/file.ts # 5. 运行测试包运行测试：单元--tests/path/to/file.test.ts 包子运行类型检查包子跑绒毛 # 6. 提交并推送 git add lib/emails/from-address.ts git commit -m“修复：解决 PR 审核反馈” git 推送 # 7. 回复话题 gh pr-审阅评论回复 --pr --repo \ --thread-id --body "$(cat <<'EOF' @审稿人感谢您的审阅！我已经解决了所有反馈： 1.中心化逻辑 2. 改善消毒 3.增加测试 abc1234 中的更改。 EOF ）” # 8. 等待然后解析线程睡眠 300 gh pr-审查线程列表 --pr --repo gh pr-review 线程解析 --pr --repo \ --线程 ID <线程 ID> # 9. 验证 gh pr-审查线程列表 --pr --repo git 状态 ** ** ## gh-pr-review 命令参考命令 |目的 ---|--- `gh 公关审查线程列表` |列出所有评论主题 `gh 公关审查线程解决` |解决特定线程 `gh 公关审查线程未解决` |重新打开已解决的线程 `gh 预审评论回复` |回复评论主题 `gh 预审核审核` |管理待审核 **常用标志：** * `--pr `：拉取请求编号 * `-R, --repo `：存储库标识符 * `--thread-id `: GraphQL 线程节点 ID ** ** ## 故障排除问题 |解决方案 ---|--- `未找到命令：gh-pr-review` |安装扩展：`gh 扩展安装 agynio/gh-pr-review` `必须通过 --pr 指定拉取请求` |从 PR 目录运行或添加 `--pr ` `--repo 在使用数字选择器时必须是所有者/repo` |添加 `-R ` 或从经过身份验证的存储库运行 Shell 使用 `--body` 转义问题 |使用heredoc： `--body "$(cat <<'EOF'\n...\nEOF)"` 找不到主题 |检查 threadId 是否是准确的 GraphQL ID，而不是 PR 号 ** ** ## 最佳实践 **回复之前：** * ✓ 仔细阅读所有评论意见 * ✓ 理解意图（建议与阻止） * ✓ 检查其他地方是否存在类似问题 **实施修复时：** * ✓ 遵循现有的代码模式 * ✓ 更新/添加更改测试 * ✓ 运行完整的测试套件 * ✓ 检查 lint 和类型错误 **回复时：** * ✓ 要有礼貌并懂得欣赏 * ✓ 解释更改的内容 * ✓ 引用特定文件/行 * ✓ 保持简洁 **解决之前：** * ✓ 确保所有问题均得到解决 * ✓ 验证测试通过 * ✓ 将更改提交到分支 ** ** ## 资源 * [gh-pr-review GitHub]() * [GitHub GraphQL API：拉取请求]() * [gh CLI 文档]()

Github PR 审核工作流程

包含技能