用途:为 GitHub 拉取请求撰写简洁、高信息量的 PR 说明,重点解释意图、影响与风险,避免重复 GitHub 已展示的信息。
主要能力与结构:
- Summary:1–3 句,说明该 PR 做什么、为何存在,聚焦行为与结果,不列文件、提交、工单或分支。
- What Changed:1–3 条短要点,只描述行为或功能变化,不写文件名或底层实现细节;无价值时可省略。
- Testing:1–2 条,具体说明如何验证(新增测试、手动流程、API 调用),避免“测试通过”这类笼统表述。
- Screenshots:仅当 PR 改动 UI 或 UX 时包含,优先内联图片而非外链;非 UI 改动完全省略。
- Risk / Rollout:简要回答是否使用功能开关、是否需要迁移、如何回滚;“No / Not needed”也是有效答案。
- Notes for Reviewers(可选):指出棘手逻辑、非显而易见的决策、需要额外关注的部分,保持简短有针对性。
规则:整体保持可快速浏览;避免重复 GitHub 已显示的信息;清晰优先于完整;不适用的部分直接省略,不用占位符填充;PR 消息始终用 markdown 代码书写。
步骤:先查看分支上的改动与提交;先写 Summary;只添加对审阅者真正有帮助的部分;输出可直接粘贴到 GitHub 的干净 PR 消息。
限制:资料未提供具体安装命令、平台支持范围、收费或价格信息。