首页/开发/Git 与协作速查/PR/MR 标题规范
协作与代码评审75 条

PR/MR 标题规范

以 squash 为主的仓库,PR 标题会成为主干提交标题:沿用提交规范(type(scope): 描述),并在 CI 里用规则校验 PR 标题。

Git 与协作速查开发更新于 2026-10-12
推荐格式<type>(<scope>): <描述>,与提交规范一致
校验在流水线里对 PR 标题跑 commitlint 规则
编辑gh pr edit --title '…'

常用示例

常用示例
gh pr create --title 'fix(login): 修复重定向循环' --body-file .github/pull_request_template.md
gh pr edit 128 --title 'fix(login): 修复重定向循环(含回归测试)'
标题保持单行、长度可控(如 100 字符内),工具与日志展示都更友好。

易错点

  • 标题写成「修复问题」「更新代码」会失去检索价值,主干日志质量直接受影响
  • 标题与最终改动不符时,squash 提交记录会误导后来者,合入前顺手更新

数据来源与参考

  • Conventional Commits 1.0.0 规范
  • GitHub Docs:About merge methods(squash 标题来源)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌