跳至主要内容

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

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

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

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

你可以为你的组织或个人帐户创建默认的拉取请求模板。有关更多信息,请参阅“创建默认的社区健康文件”。

添加拉取请求模板

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

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

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

    Screenshot of the main page of a repository. Above the list of files, a button, labeled "Add file," is outlined in dark orange. In the file tree view of the repository, a button with a plus sign icon is also outlined in dark orange.

  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. 在“提交消息”字段中,键入一个简短且有意义的提交消息,描述你对文件所做的更改。你可以在提交消息中将提交归因于多个作者。有关更多信息,请参阅“创建具有多个作者的提交”。

  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. 点击**提交更改**或**建议更改**。

进一步阅读