用途:基于分支 diff 自动生成完整的 Pull Request 描述,帮助开发者整理并规范 PR 文档。
主要能力:
- 收集上下文:获取当前分支名(git branch --show-current)、查找基础分支(git remote show origin | grep 'HEAD branch')、列出本分支提交(git log main..HEAD --oneline),并获取完整 diff(git diff main...HEAD --stat、git diff main...HEAD)。
- 分析变更并按类别归类:功能(Features)、修复(Fixes)、重构(Refactors)、文档(Docs)、测试(Tests)、杂项(Chores)。
- 按固定模板生成 PR 描述,包含摘要、变更列表、变更类型、测试、截图(如适用)和检查清单。
- 确定 PR 标题,格式为 type(scope): description,例如 feat(auth): add OAuth2 login support。
- 输出建议的标题、Markdown 格式的完整描述,以及(若存在 CODEOWNERS 或 .github/labels.yml)建议的审查者和标签。
- 可选创建 PR:在用户确认后运行 gh pr create --title "..." --body "..."。
使用方式:在需要创建或准备 PR 时调用,按上述步骤执行 git 与 gh 命令,最终输出建议标题与描述。
适用场景:开发者在提交 PR 前整理变更说明、生成 PR 文档、确定标题格式。
限制:资料未说明具体平台支持范围或额外依赖条件。