Skip to main content

Creating a pull request template for your repository

When you add a pull request template to your repository, project contributors will automatically see the template's contents in the pull request body.

For more information, see "About issue and pull request templates."

You can create a PULL_REQUEST_TEMPLATE/ subdirectory in any of the supported folders to contain multiple pull request templates, and use the template query parameter to specify the template that will fill the pull request body. For more information, see "Using query parameters to create a pull request."

You can create default pull request templates for your organization or personal account. For more information, see "Creating a default community health file."

Adding a pull request template

  1. On GitHub.com, navigate to the main page of the repository.
  2. 在文件列表上方,使用“添加文件”下拉列表,在其中单击“创建新文件” 。 “添加文件”下拉列表中的“创建新文件”
  3. In the file name field:
    • To make your pull request template visible in the repository's root directory, name the pull request template pull_request_template.md. New pull request template name in root directory
    • To make your pull request template visible in the repository's docs directory, name the pull request template docs/pull_request_template.md. New pull request template in docs directory
    • To store your file in a hidden directory, name the pull request template .github/pull_request_template.md. New pull request template in hidden directory
    • To create multiple pull request templates and use the template query parameter to specify a template to fill the pull request body, type .github/PULL_REQUEST_TEMPLATE/, then the name of your pull request template. For example, .github/PULL_REQUEST_TEMPLATE/pull_request_template.md. You can also store multiple pull request templates in a PULL_REQUEST_TEMPLATE subdirectory within the root or docs/ directories. For more information, see "Using query parameters to create a pull request." New multiple pull request template in hidden directory
  4. In the body of the new file, add your pull request template. This could include:
    • A reference to a related issue in your repository.
    • A description of the changes proposed in the pull request.
    • @mentions of the person or team responsible for reviewing proposed changes.
  5. 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建具有多个共同作者的提交”。 更改的提交消息
  6. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建新的拉取请求”。 提交分支选项 Templates are available to collaborators when they are merged into the repository's default branch.
  7. 单击“提供新文件”。 “提供新文件”按钮

Further reading