为仓库创建拉取请求模板
将拉取请求模板添加到仓库后,项目贡献者会自动在拉取请求正文中看到模板的内容。
本文内容
更多信息请参阅“关于议题和拉取请求模板”。
您可以在任何支持的文件夹中创建 PULL_REQUEST_TEMPLATE/ 子目录,以包含多个拉取请求模板,并使用 template
查询参数指定填充拉取请求正文的模板。 更多信息请参阅“关于使用查询参数自动化议题和拉取请求”。
添加拉取请求模板
-
在 GitHub Enterprise 上,导航到仓库的主页面。
-
在文件列表上方,单击 Create new file(创建新文件)。
-
在文件名字段中:
- To make your pull request template visible in the repository's root directory, name the pull request template
pull_request_template.md
. - To make your pull request template visible in the repository's
docs
directory, name the pull request templatedocs/pull_request_template.md
. - To store your file in a hidden directory, name the pull request template
.github/pull_request_template.md
. - 要创建多个拉取请求模板,并使用
template
查询参数指定填充拉取请求正文的模板,请输入 .github/PULL_REQUEST_TEMPLATE/,后接拉取请求模板的名称。 例如.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
。 您也可以在根目录或docs/
目录的PULL_REQUEST_TEMPLATE
子目录中存储多个拉取请求模板。 更多信息请参阅“关于使用查询参数自动化议题和拉取请求”。
- To make your pull request template visible in the repository's root directory, name the pull request template
-
在新文件的正文中,添加您的拉取请求模板。 这可能包括:
-
在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 更多信息请参阅“创建有多个合作作者的提交”。
-
在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是
master
,则应选择为提交创建新分支,然后创建拉取请求。 更多信息请参阅“创建新的拉取请求”。Templates are available to collaborators when they are merged into the repository's default branch. -
单击 Propose new file(提议新文件)。