Creating a pull request template for your repository

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 "About automation for issues and pull requests with query parameters."

Adding a pull request template

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

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

   

3. In the file name field:

   • To make your pull request template visible in the repository's root directory, type the name of your pull request template. For example, pull_request_template.md.
     
   • To make your pull request template visible in the repository's docs directory, type docs/, then the name of your pull request template. For example, docs/pull_request_template.md.
     
   • To store your file in a hidden directory, type .github/, then the name of your pull request template. For example, .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 "About automation for issues and pull requests with query parameters."
     

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. 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. Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is master, you should choose to create a new branch for your commit and then create a pull request.

   Templates are available to collaborators when they are merged into the repository's default branch.

7. Click Propose new file.

   

Further reading

• "About issue and pull request templates"
• "About automation for issues and pull requests with query parameters"
• "Creating a pull request"