用途:在打开新 PR、补充或刷新已有 PR 描述,以及为后续排查保留实现理由时,生成并发布高质量的 PR 描述,帮助评审者理解意图、实现细节与验证步骤。
主要能力:PR 描述需回答改了什么、为何现在改、如何实现、如何测试、遗留哪些风险或后续项;工作流包括发现 PR 上下文与变更文件、从提交和代码变更提取意图、起草结构化正文、写入 PR、重新打开 PR 视图并确认正文与标签。
必要用法:常用命令为 gh pr view --json number,title,url,baseRefName,headRefName 识别当前分支 PR;gh pr diff --name-only 与 gh pr diff 查看变更;git log --oneline --decorate -n 10 查看提交意图;gh pr edit <pr-number> --body-file /tmp/pr-body.md 写回正文。正文使用模板,必含 Why、What Changed、Implementation Details、Testing、Risks / Follow-ups 五节。质量要求:具体到文件、路由、脚本和命令;解释取舍与限制;测试节写明实际命令与结果;未测试内容需明确说明。
适用场景:常规 PR 创建与维护、大 diff 的评审引导、UI 工作补截图、发布顺序重要时补 Rollout Notes、需要留下实现理由时。
限制:资料未提供具体模板内容、安装方式、收费与平台支持范围;模板文件 references/pr-body-template.md 的具体内容暂未提供。