Update Pull Request Template [ci-skip] #45495
Conversation
.github/pull_request_template.md
Outdated
| these bugs have open GitHub issues, be sure to tag them here as well, | ||
| to keep the conversation linked together. --> | ||
| This template aims to help contributors to write better descriptions. | ||
| Feel free to discard it if you need to. |
There was a problem hiding this comment.
I feel like this needs a bit more. How about something like:
The following template aims to help contributors write a good description for their pull requests. We'd like you to provide a description of the changes in your pull request (ie bugs fixed or features added), motivation behind the changes, and complete the checklist below before opening a pull request.
There was a problem hiding this comment.
I think this really needs to be in a comment block too... if not, it will get left untouched often, and every PR notification will end up starting with the same words.
There was a problem hiding this comment.
@eileencodes @matthewd I put them into a comment. I also added some more comments for motivation section.
okuramasafumi
force-pushed
the
rewrite-pull-request-template
branch
from
1b5ceab
to
656b7b4
Compare
The major change is to add checklist so that it's easier to be read than comments. Also, `Summary` is not clear about what should be written, so here it's changed to `Motivation` and `Detail`. Finally, it clearly says they can discard this template if they need to.
okuramasafumi
changed the title
okuramasafumi
force-pushed
the
rewrite-pull-request-template
branch
from
4dd7df6
to
69d68a3
Compare
Summary
This change aims to help contributors to write better Pull Request description, especially new contributors.
From my experience new contributors cannot tell if they can discard a template even when they just fix a typo, so here it's clearly documented that it's discardable.