-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Update PULL_REQUEST_TEMPLATE.md #8831
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! The structure is simple and has already proven useful. 🚀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggesting a 'Related' section. LGTM otherwise!
|
||
- [ ] ... | ||
- [ ] ... | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Related | |
Issues, PRs or external links that give more context to this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i would argue that these should go into the motivation section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added a comment 👍
Motivation
It's been on the TODO list for a long time to create a PR template. The initial attempt in #6084 ended up becoming stale, mostly because the template was a little too involved. Moreover, the long list of check boxes in the template lead to all issues having something like "2 of 14 tasks" indicators in the overview, which is a bit misleading, since some of them are single choice lists so PRs will always appear as incomplete unless you delete the list of tasks.
The Motivation and Changes structure has found itself into many PRs by a number of Authors. Examples:
So it seems this could a good minimal standard structure!
Changes