用途:根据分支改动,生成结构清晰的 pull request 描述并创建 PR。
主要能力与流程:
- 依次通过四道闸门:分支闸门确认当前分支不是默认分支(main、master 或仓库文档指定的默认分支);证据闸门要求已针对将要总结的 main..HEAD(若本地无 main 则用 origin/main..HEAD)范围运行上下文命令;模板闸门要求最终标题与正文不含 <...>、TODO、TBD 等未替换占位符,无内容的可选段落应删除;创建闸门要求 gh pr create 成功并输出 PR URL 或编号。
- 收集上下文命令:git branch --show-current、git log --oneline main..HEAD、git log --format="### %s%n%n%b" main..HEAD、git diff --stat main..HEAD、git diff main..HEAD。
- 分析改动类型、动机、影响与测试情况,并从提交信息、分支名、代码注释中查找关联 issue。
- 使用约定式提交标题格式,如 feat(scope)、fix(scope)、refactor(scope)、docs(scope)、test(scope)、chore(scope)。正文模板含 Summary、Changes(Added/Changed/Fixed/Removed)、Motivation、Testing(含手动测试步骤)、Breaking Changes、Related Issues、Checklist;空的可选段落应移除。
- 创建后可用 gh pr edit <number> --add-label <label> 添加标签,先以 gh label list 查看可用标签;常见类型标签有 enhancement、bug、documentation、breaking-change。breaking-change 仅用于需用户修改配置、CLI 调用或 API 集成的面向用户变更,不应因内部重构而添加。
- 创建后展示 PR URL 与已加标签,建议添加 reviewer,并提示需通过的 CI 检查。
限制:不得在未通过各闸门时起草或运行 gh pr create;命令失败时不得声称 PR 已创建;资料未提供价格、收费、平台支持范围等信息。