Skip to main content

此版本的 GitHub Enterprise Server 将于以下日期停止服务 2024-08-29. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

为仓库创建拉取请求模板

将拉取请求模板添加到仓库后,项目贡献者会自动在拉取请求正文中看到模板的内容。

有关详细信息,请参阅“关于议题和拉取请求模板”。

可以在任何支持的文件夹中创建 PULL_REQUEST_TEMPLATE/ 子目录,以包含多个拉取请求模板,并使用 template 查询参数指定填充拉取请求正文的模板。 有关详细信息,请参阅“使用查询参数创建拉取请求”。

你可以为组织或个人帐户创建默认拉取请求模板。 有关详细信息,请参阅“创建默认的社区运行状况文件”。

添加拉取请求模板

  1. 在 你的 GitHub Enterprise Server 实例 上,导航到存储库的主页。

  2. 在文件列表上方,使用“添加文件”下拉列表,在其中单击“创建新文件” 。

  3. 在文件名字段中:

    • 若要使拉取请求模板显示在存储库根目录中,请将拉取请求模板命名为 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 子目录中存储多个拉取请求模板。 有关详细信息,请参阅“使用查询参数创建拉取请求”。
  4. 在新文件的正文中,添加您的拉取请求模板。 此模板可能包括要求用户包含以下内容:

  5. 在“提交消息”字段中,输入简短、有意义的提交消息,以描述对文件的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建有多个作者的提交”。

  6. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建拉取请求”。

    GitHub 拉取请求的屏幕截图,其中显示了一个单选按钮,用于直接提交到主分支或创建新分支。 已选择“新建分支”。
    模板可供协作者用来合并到存储库的默认分支。

  7. 单击“提交更改”或“建议更改” 。

延伸阅读