Skip to main content

为仓库创建拉取请求模板

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

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

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

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

添加拉取请求模板

  1. 在 your GitHub Enterprise Server instance 上,导航到存储库的主页。 1. 在文件列表上方,使用“添加文件”下拉列表,在其中单击“创建新文件” 。 “添加文件”下拉列表中的“创建新文件”
  2. 在文件名字段中:
    • 若要使拉取请求模板显示在存储库根目录中,请将拉取请求模板命名为 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 子目录中存储多个拉取请求模板。 有关详细信息,请参阅“关于使用查询参数自动处理问题和拉取请求”。 隐藏目录中新的多拉取请求模板
  3. 在新文件的正文中,添加您的拉取请求模板。 这可能包括:
  4. 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建具有多个共同作者的提交”。 更改的提交消息 1. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建新的拉取请求”。 提交分支选项 模板可供协作者用来合并到存储库的默认分支。
  5. 单击“提供新文件”。 “提供新文件”按钮

延伸阅读