When you add a pull request template to your repository, project contributors will automatically see the template's contents in the pull request body. Templates customize and standardize the information you'd like included when contributors create pull requests.

Sample pull request template

Contributors can use templates to describe the proposed changes in their pull requests according to the repository's contributing guidelines. For more information, see "Setting guidelines for repository contributors."

You can store your pull request template in the repository's visible root directory, the docs folder, or the hidden .github directory. Pull request template filenames are not case sensitive, and can have an extension such as .md or .txt.

Tip: You must create your template in your repository's default branch. Templates created in other branches are not available for collaborators to use.

Adding a pull request template

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

  2. Above the file list, click Create new file. The New file button

  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. New pull request template name in root directory
    • 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. New pull request template in docs directory
    • 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. New 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. 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." Commit message for your change

  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. Commit branch options Templates are available to collaborators when they are merged into the repository's default branch.

  7. Click Propose new file. Commit new file button

Adding multiple pull request templates

You can create a PULL_REQUEST_TEMPLATE/ subdirectory in any of the supported folders to contain multiple pull request templates. Use the template query parameter to specify the template that will automatically fill the pull request body. For more information, see "About automation for issues and pull requests with query parameters."

Further reading