跳至主要内容

为您的仓库创建拉取请求模板

当您向仓库添加拉取请求模板时,项目贡献者在创建拉取请求时会自动看到模板内容,显示在拉取请求的正文中。

本文内容

更多信息请参阅 关于问题和拉取请求模板

您可以在任意受支持的文件夹中创建 PULL_REQUEST_TEMPLATE/ 子目录,以存放多个拉取请求模板,并使用 template 查询参数来指定用于填充拉取请求正文的模板。更多信息请参阅 使用查询参数创建拉取请求

您可以为组织或个人账户创建默认的拉取请求模板。更多信息请参阅 创建默认社区健康文件

添加拉取请求模板

  1. 在 GitHub 上,导航至仓库的主页面。

  2. 在文件列表上方,选择 添加文件下拉菜单,然后点击 创建新文件

    或者,您可以点击在左侧的文件树视图中。

    Screenshot of the main page of a repository highlighting both the "Add file" and the "plus sign" icon, described above, with an orange outline.

  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. 在“Commit message”字段中,键入简短且有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息,请参阅 创建拥有多位作者的提交

  7. 在提交信息字段下方,决定是将提交添加到当前分支还是新分支。如果您当前的分支是默认分支,建议为提交创建一个新分支,然后发起拉取请求。欲了解更多信息,请参阅 创建拉取请求

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.
    当模板合并到仓库的默认分支后,协作者即可使用这些模板。

  8. 点击 提交更改提议更改

延伸阅读

© . This site is unofficial and not affiliated with GitHub, Inc.