用途
pr-reviewer-guide 是一个用于生成拉取请求(PR)审查说明的技能。它的目标是让 PR 作者与审查者共享同一份“心智地图”,在审查开始前就理解这次变更的意图、关键决策、系统结构、未经验证的假设以及生产故障的排查入口。
主要能力
该技能围绕五个问题组织输出,并要求按顺序作答:
- 意图是什么:说明所解决的问题、目标以及遵循的原则,例如“不破坏公共 API”“默认安全”“小而可验证的步骤”。
- 做了哪些决策:区分不可逆决策与可逆决策。不可逆决策来自决策日志,并说明为何不可逆;同时列出实践中不可逆但没有记录的隐性决策(如没有迁移路径),并明确标注“无记录”。可逆决策每条一行。此外还包括来自规格的产品决策。
- 什么能维持心智地图:以编号列表描述系统的主要部分、数据存放位置、检查顺序、会话、用户、配置、启动方式、测试如何构建、文档位置,并为最重要的流程附一小段 ASCII 图。
- 哪些假设未经验证:具体而诚实地列出部署平台、代理、HTTPS、实例数量、测试过的浏览器与版本、运行时版本、原生二进制、真实数据迁移、客户端行为等,并说明每项假设所影响的部分。
- 生产故障时先看哪里:给出应搜索的日志消息与级别、启动时的警告与致命配置错误,以及一张“症状—首要怀疑对象”两列表格。
使用方式
在撰写之前,需要阅读规格、计划、决策日志、.scratchpad/<slug>/ 下的报告、diff 以及 PR 描述,并逐条核对所有陈述,不得凭记忆作答。
交付流程为:
- 先在对话中用用户的语言作答。
- 将文本保存到 .scratchpad/<slug>/pr-guide.md。
- 如果用户希望发布到 PR,则将其翻译为 simplified-technical-language 的文档语言,保存到 .scratchpad/<slug>/pr-guide-comment.md。
- 使用 gh pr comment <number> --body-file .scratchpad/<slug>/pr-guide-comment.md 发布,或在 GitLab 上使用 glab mr note <number> --message "$(cat .scratchpad/<slug>/pr-guide-comment.md)"。若没有这些工具,则使用当前环境的工具。
- 报告评论 URL。
适用场景
适用于需要让审查者快速建立整体理解的 PR,尤其是包含不可逆决策、跨模块改动、部署与配置变更,或涉及未验证假设的变更。也适合作为 PR 描述之外的补充说明,帮助团队在生产故障时快速定位排查方向。
限制
资料未提供该技能的安装方式、支持的具体平台范围、收费信息或效果保证。输出质量依赖规格、计划、决策日志与报告等前置材料是否齐全;对于缺失记录的信息,只能明确标注为“无记录”,不能补写。发布评论需要 gh 或 glab 等工具,或其他环境工具支持。