Skip to content
BankyBluePrints.com

Configuring Pull Request and Issue Templates

Introduction

Section titled “Introduction”

Templates guide contributors to provide consistent information in pull requests and issues.

Repository Structure

Section titled “Repository Structure”
  • Pull request template: .github/pull_request_template.md
  • Issue templates: .github/ISSUE_TEMPLATE/bug_report.md, .github/ISSUE_TEMPLATE/feature_request.md

Enable Default Templates

Section titled “Enable Default Templates”
  1. Commit the template files to the default branch.
  2. For issue templates, include a .yml file in .github/ISSUE_TEMPLATE/ describing each template.
  3. To make a default pull request template, name it pull_request_template.md in the .github directory.
  4. Optional: enable discussion templates for GitHub Discussions.

Example Pull Request Template

Section titled “Example Pull Request Template”
## Summary
-


## Testing
- [ ] `npm test`

Further Reading

Section titled “Further Reading”