我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

为仓库创建拉取请求模板

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

本文内容

更多信息请参阅“关于议题和拉取请求模板”。

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

您可以为组织创建默认拉取请求模板。 更多信息请参阅“为组织创建默认社区健康文件”。

添加拉取请求模板

  1. On GitHub, navigate to the main page of the repository.

  2. Above the file list, click Create new file.

    The New file button

  3. 在文件名字段中:

    • 要使拉取请求模板显示在仓库的根目录中,请输入拉取请求模板的名称。 例如 pull_request_template.md
      根目录中的新拉取请求模板名称
    • 要使拉取请求模板显示在仓库的 docs 目录中,请输入 docs/,后接拉取请求模板的名称。 例如 docs/pull_request_template.md
      Docs 目录中的新拉取请求模板
    • 要将文件存储在隐藏的目录中,请输入 .github/,后接拉取请求模板的名称。 例如 .github/pull_request_template.md
      隐藏目录中的新拉取请求模板
    • 要创建多个拉取请求模板,并使用 template 查询参数指定填充拉取请求正文的模板,请输入 .github/PULL_REQUEST_TEMPLATE/,后接拉取请求模板的名称。 例如 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md。 您也可以在根目录或 docs/ 目录的 PULL_REQUEST_TEMPLATE 子目录中存储多个拉取请求模板。 更多信息请参阅“关于使用查询参数自动化议题和拉取请求”。
      隐藏目录中新的多拉取请求模板
  4. 在新文件的正文中,添加您的拉取请求模板。 这可能包括:

  5. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

    有关更改的提交消息

  6. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

    提交分支选项 Templates are available to collaborators when they are merged into the repository's default branch.

  7. Click Propose new file.

    Propose new file button

延伸阅读

问问别人

找不到要找的内容?

联系我们