Introduce PR templates
adetunjii opened this issue · comments
The problem/use-case that the feature addresses
It's ideal to have a template for pull requests in an open-source repo. This helps PRs follow a consistent format and IMO, gives reviewers a quick overview of what the PR entails.
A sample template:
<!--
Please remove comments like this one, but keep and use the rest of the template.
See CONTRIBUTING.md for details.
-->
# Description
<!--
Write a short description to explain changes that are not mentioned in the initial issue.
What were the reasons for those changes?
Which decisions did you make and why?
What else should reviewers know about your changes?
-->
<!-- Replace <issue_number> with an actual issue number. -->
Closes/Fixes <issue_number>
## Readiness checklist
<!-- Please check all items in this checklist that were done. -->
- [ ] I added/updated unit tests (and they pass).
- [ ] I added/updated integration/compatibility tests (and they pass).
- [ ] I added/updated comments and checked rendering.
- [ ] I made spot refactorings.
- [ ] I updated user documentation.
- [ ] I ensured that PR title is good enough for the changelog.
I'm not the biggest fan of PR templates, I find them more useful for automation than anything else, but happy to hear what other folks think.
I'm skeptical. It'd just be boilerplate. If the PR is just one commit, then the description defaults to the commit message, which I find very useful. I don't know if that's still the case with a template.
Marking to closed unless anyone else comes in an advocates for it.