PR 摘要助手
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_c283aad7/gy3 技能到你的 AI 助手。
技能介绍
要解决的问题
在代码评审流程中,PR 描述的质量直接影响审查效率。开发者提交 PR 时,常面临两个困境:要么描述过于简略,审查者无法快速理解变更意图;要么事无巨细地堆砌信息,淹没关键内容。gy3 技能的目标是让 PR 描述聚焦于审查者真正需要的信息——用户可见行为变化、内部重构、迁移内容以及测试覆盖情况。
核心能力与工作方式
gy3 按固定工作流处理变更:
- 检查变更文件与测试:当测试文件存在时,一并纳入分析范围。
- 分类变更内容:将变更拆分为四类——用户可见行为、内部重构、迁移工作、测试覆盖,每类独立呈现。
- 风险与后续工作:仅在确有必要时才提及风险或后续待办,避免制造噪音。
- 保持简短事实化:摘要以事实为基础,控制篇幅。
模板设计上,gy3 遵循一个原则:当没有有用内容可写时,直接省略 Notes 部分。这避免了为凑篇幅而生成无意义文本。
适用边界与注意点
gy3 适合标准 Git 工作流下的 PR 场景,依赖仓库中的变更文件作为输入。以下几点需要注意:
- 技能分析的是
diff内容,无法感知未提交的代码或仓库外上下文。 - 当变更涉及复杂的跨仓库依赖时,摘要可能不完整,仍需人工补充。
- "风险仅在确有必要时提及"意味着技能不会自动列举所有潜在问题,审查者仍需自行判断。
- 生成的摘要偏保守,适合作为草稿起点,团队可按需调整格式和内容粒度。
使用场景
- 合并大型功能分支前,需要一份清晰的 PR 描述,让审查者快速区分用户可见变更与内部重构。
- 团队提交的 PR 描述缺少统一规范,需要快速生成一份结构化、事实性的变更摘要草稿。
- 涉及数据库迁移的 PR,需要在摘要中单独说明迁移步骤与测试覆盖情况,方便审查者评估风险。
- PR 中没有实质风险或后续工作可写时,需要直接省略 Notes 部分,而不是凑字数生成注水内容。
适合人员
- 开源项目维护者:每天要审查大量外部贡献者的 PR,需要标准化的描述草稿节省时间。
- 后端工程师:提交同时包含重构与迁移的 PR 时,希望摘要分开说明功能变化与技术改动。
- 测试工程师:想快速确认 PR 的测试覆盖范围,需要摘要中单独列出测试相关变更。
- 初创团队技术负责人:团队没有统一 PR 模板,希望用固定格式生成事实性的变更摘要。