用途:从两个本地 Git 分支的差异生成 GitHub PR 标题和描述,聚焦评审者关心的内容,包括目的、关键决策与假设、行为或概念性变更,以及必要的测试说明。仅使用标准 git 命令,任何智能体都可遵循。
主要能力与用法:
- 解析分支。两个分支都指定则直接使用;只指定一个则作为 base,target 默认为当前分支;都未指定则 base 默认 main,若 main 不存在则用 master(git branch --list),只检查这两个名字,都不存在则停止并询问,target 默认为当前分支(git branch --show-current)。继续前先说明解析出的 base/target。
- 生成 diff。用 git branch --list <name> 确认两分支存在,否则停止;执行 git diff <base>...<target> 和 git log <base>..<target> --oneline;diff 为空则停止并说明,不得编造描述。
- 分析。从 diff/log 识别变更目的、关键决策与权衡、代码依赖的假设、具体行为变更、概念/契约变更、破坏性变更、新配置或环境变量、迁移、测试变更;跳过格式化、琐碎重命名等常规内容,不逐文件逐行罗列。
- 输出结构。写入仓库根目录 prDescription.md(存在则覆盖),包含标题(祈使句,少于70字符)、Summary、Key Decisions & Assumptions、Behavioral / Conceptual Changes、Testing、Notes 等小节,空小节省略,整体约150-200词,一分钟内可读完。不得编造测试细节、工单或姓名,不确定处写入 Notes。
- 确认。写完后简短确认,不重印文件,并建议在 gh 可用时运行 gh pr create --title "..." --body-file prDescription.md,命令中包含解析出的 base 和 target 分支名;最后询问是否现在创建 PR,等待确认后再继续,用户拒绝则停止并说明描述已就绪。
限制:仅处理本地分支,不扫描其他分支名;diff 为空或分支不存在时停止;不编造信息。