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.
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):
Afterwards the contents of the file are displayed in the pull reqest creator editor in the description text area - incl. Markdown support.
Related articles
Oct 16, 2021 - 1 min read
Better GitHub Readmes with Readme Generator
Every time a new repository is created on GitHub there is one problem: the structure and appearance of readme.md. But thanks to Katherine …
BEN ABT
Ben is Chief Engineering Officer and Principal Software Engineer at Medialesson.de, with a strong focus on .NET and Microsoft Azure. In his professional role, he designs and builds highly scalable platforms for hybrid and cloud-based scenarios. He also advises companies and C-levels on migrating to the sovereign cloud.
He runs myCSharp.de, the largest and most active German-speaking C# community forum, actively contributes to both his own and external open-source projects and regularly shares his knowledge through his blog, at community events, conferences and as a writer for technical magazines.
Let's Work Together
Looking for an experienced Platform Architect or Engineer for your next project? Whether it's cloud migration, platform modernization or building new solutions from scratch - I'm here to help you succeed.