Issue and Pull Request templates
It’s hard to solve a problem when important details are missing. Now project maintainers can add templates for Issues and Pull Requests to projects, helping contributors share the right details…
It’s hard to solve a problem when important details are missing. Now project maintainers can add templates for Issues and Pull Requests to projects, helping contributors share the right details at the start of a thread. This is the first of many improvements to Issues and Pull Requests that we’re working on based on feedback from the community.
To add an Issue template to a repository create a file called ISSUE_TEMPLATE
in the root directory. A file extension is optional, but Markdown files (.md) are supported. Markdown support makes it easy to add things like headings, links, @-mentions, and task lists to your templates.
Pull Request templates follows the same pattern: add a file called PULL_REQUEST_TEMPLATE
to the root directory of your repository.
If you’re worried about the added clutter in the root directory of your project, we also added support for a .github/
folder. You can put CONTRIBUTING.md
, ISSUE_TEMPLATE.md
, and PULL_REQUEST_TEMPLATE.md
files in .github/
and everything will work as expected.
Check out the documentation for additional information on the feature.
Written by
Related posts
Beginner’s guide to GitHub: Adding code to your repository
Take the next step in our GitHub for Beginners series and add code to your repository. Learn how to create branches and upload changes into a pull request.
How to review code effectively: A GitHub staff engineer’s philosophy
GitHub Staff Engineer Sarah Vessels discusses her philosophy of code review, what separates good code review from bad, her strategy for finding and reviewing code, and how to get the most from reviews of her own code.
Beginner’s guide to GitHub: Uploading files and folders to GitHub
The next step in our GitHub for Beginners series is learning how to add files and folders to your GitHub repository.