首页/开发/Git 与协作速查/PR 模板文件(GitHub)
协作与代码评审75 条

PR 模板文件(GitHub)

把评审检查项固化为模板:.github/pull_request_template.md 对全部 PR 生效;也可用 .github/PULL_REQUEST_TEMPLATE/ 目录放多个模板按 URL 参数选用。

Git 与协作速查开发更新于 2026-10-12
单模板.github/pull_request_template.md(大小写不敏感)
多模板.github/PULL_REQUEST_TEMPLATE/<名称>.md,创建时用 template=<名称>
生效范围仓库默认分支上的模板对新建 PR 生效

模板示例

模板示例
## 变更说明
<!-- 一句话说明目的 -->

## 检查清单
- [ ] 已补充/更新测试
- [ ] 已更新文档(如需要)
- [ ] 破坏性变更已在描述中标注

## 关联 Issue
Closes #
模板越短越容易被认真填写;检查项应与 CI 门禁互补,不重复已经自动化的内容。

易错点

  • 模板放在非默认分支不会生效,建库初期就要上传到默认分支
  • 模板里留大量注释占位符却不删,会让描述显得冗长

数据来源与参考

  • GitHub Docs:Creating a pull request template for your repository
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌