有关更多信息,请参阅“关于问题和拉取请求模板”。
您可以在任何受支持的文件夹中创建 _PULL_REQUEST_TEMPLATE/ 子目录以包含多个拉取请求模板,并使用 template 查询参数指定将填充拉取请求正文的模板。有关更多信息,请参阅“使用查询参数创建拉取请求”。
您可以为您的组织或个人帐户创建默认的拉取请求模板。有关更多信息,请参阅“创建默认社区健康文件”。
添加拉取请求模板
-
在 GitHub.com 上,导航到仓库的主页。
-
在文件列表上方,选择 **添加文件** 下拉菜单,然后点击 创建新文件.
或者,您可以点击 左侧的文件树视图中的。
-
在文件名字段中
- 要使您的拉取请求模板在仓库的根目录中可见,请将拉取请求模板命名为
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
子目录中。有关更多信息,请参阅 "使用查询参数创建拉取请求。"。
- 要使您的拉取请求模板在仓库的根目录中可见,请将拉取请求模板命名为
-
在新文件的正文中,添加您的拉取请求模板。此模板可以包含要求包含
- 一个 对仓库中相关问题的引用。
- 拉取请求中提出的更改的描述。
- @提及 负责审查提议更改的人员或团队。
-
点击 **提交更改...**
-
在“提交消息”字段中,输入简短且有意义的提交消息,描述您对文件所做的更改。您可以在提交消息中将提交归功于多个作者。有关更多信息,请参阅“创建具有多个作者的提交”。
-
在提交消息字段下方,决定是将您的提交添加到当前分支还是新分支。如果您的当前分支是默认分支,您应该选择为您的提交创建一个新分支,然后创建一个拉取请求。有关更多信息,请参阅“创建拉取请求”。
当模板合并到存储库的默认分支时,协作者可以使用它们。 -
点击提交更改或提出更改。
进一步阅读
- "关于问题和拉取请求模板"
- "创建问题"
- "创建拉取请求"