Skip to content

Latest commit

 

History

History
43 lines (36 loc) · 3.64 KB

creating-a-pull-request-template-for-your-repository.md

File metadata and controls

43 lines (36 loc) · 3.64 KB
Raw
title intro redirect_from versions topics shortTitle
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.
/articles/creating-a-pull-request-template-for-your-repository
/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository
fpt ghes ghec
*
*
*
Community
Create a PR template

For more information, see "AUTOTITLE."

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 "AUTOTITLE."

You can create default pull request templates for your organization or personal account. For more information, see "AUTOTITLE."

Adding a pull request template

{% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %}

  1. 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.
    • To make your pull request template visible in the repository's docs directory, name the pull request template docs/pull_request_template.md.
    • To store your file in a hidden directory, name the pull request template .github/pull_request_template.md.
    • 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 "AUTOTITLE."
  2. In the body of the new file, add your pull request template. This template could consist of asking to 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. {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} Templates are available to collaborators when they are merged into the repository's default branch. {% data reusables.files.propose_new_file %}

Further reading