GitHub 为仓库创建拉取请求模板
将拉取请求模板添加到仓库后,项目贡献者会自动在拉取请求正文中看到模板的内容。
更多信息请参阅“关于议题和拉取请求模板”。
您可以在任何支持的文件夹中创建 PULL_REQUEST_TEMPLATE/ 子目录,以包含多个拉取请求模板,并使用 template
查询参数指定填充拉取请求正文的模板。 更多信息请参阅“关于使用查询参数自动化议题和拉取请求”。
您可以为组织或用户帐户创建默认的拉取请求模板。 更多信息请参阅“创建默认社区健康文件”。
添加拉取请求模板
- 在 GitHub 上,导航到仓库的主页面。
- 在文件列表上方,使用 Add file 下拉菜单,点击 Create new file。
- 在文件名字段中:
- 要使拉取请求模板在存储库的根目录中可见,请将拉取请求模板命名为
pull_request_template.md
。
- 要使拉取请求模板在仓库的
docs
目录中可见,请将拉取请求模板命名为docs/pull_request_template.md
。
- 要将文件存储在隐藏目录中,请将拉取请求模板命名为
.github/pull_request_template.md
。
- 要创建多个拉取请求模板,并使用
template
查询参数指定填充拉取请求正文的模板,请输入 .github/PULL_REQUEST_TEMPLATE/,后接拉取请求模板的名称。 例如.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
。 您也可以在根目录或docs/
目录的PULL_REQUEST_TEMPLATE
子目录中存储多个拉取请求模板。 更多信息请参阅“关于使用查询参数自动化议题和拉取请求”。
- 在新文件的正文中,添加您的拉取请求模板。 这可能包括:
- 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 更多信息请参阅“创建有多个合作作者的提交”。
- 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建一个新分支,然后创建一个拉取请求。 更多信息请参阅“创建新的拉取请求”。
模板可供协作者用来合并到仓库的默认分支。
- 单击 Propose new file(提议新文件)。