Custom GitHub Pull Request Templates

October 22, 2021 1 min read BEN ABT

For some time now, GitHub has offered the possibility to create custom pr templates , so that a kind of template is automatically embedded in the editor when creating.

But one variant has always worked so far: a single template in the root directory of the repository: for this purpose the file “PULL_REQUEST_TEMPLATE.md” must be created and checked in directly in the main directory. As an example you can use the following content.

Markdown
 1<!--- Provide a general summary of your changes in the Title above -->
 2
 3## Description
 4<!--- Describe your changes in detail -->
 5
 6## Related Issue(s)
 7
 8<!--- Please link to the issue(s) here: -->
 9
10## How Has This Been Tested?
11
12* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
13* [ ] Have you written new tests for your core changes, as applicable?
14* [ ] Have you successfully ran tests with your changes locally?
15
16## Screenshots (if appropriate):