用途:为 Paddle 相关仓库创建或更新 GitHub Pull Request,并生成符合官方模板的 PR 描述。
主要能力与流程:
- 检查分支状态:确认当前分支是否已推送到远端,未推送则执行 git push -u origin HEAD;若分支为 main 或 master,需先向用户确认是否直接提 PR。
- 按逻辑主题整理改动:不逐条罗列 commit,而是按功能或目的分组,说明改动原因、解决的问题和涉及模块。
- 使用 Paddle 官方 PR 模板(https://github.com/PaddlePaddle/Paddle/blob/develop/.github/PULL_REQUEST_TEMPLATE.md),包含 PR Category、PR Types、Description、是否引起精度变化四个三级标题小节;Description 正文不使用三级及以上标题,分段最多用四级标题。
- 提交前运行 prek 做格式检查;若自动修改文件,则 git add .、git commit -m "🔧 chore: apply prek fixes"、git push 后继续;无法自动修复的错误需手动修复并重跑,全部通过后再创建或更新 PR。
- 使用 gh 命令创建或更新 PR,标题用英文,推荐格式 [PR 大类] 简要说明,避免 fix bug、update code 等含糊标题。
限制与注意:始终遵循官方模板章节结构,不自定义顶层标题;优先说明改动动机;背景不清时先向用户澄清;成功后返回 PR URL;描述优先使用中文;不要将任何 bot 或机器账号加入协作者。具体命令与模板内容以资料为准。