-
-
Notifications
You must be signed in to change notification settings - Fork 667
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
DOC: Advise users to delete the PR template in message. #152
DOC: Advise users to delete the PR template in message. #152
Conversation
Folks, when the transition to GitHub was triggered many of the commit message contained only the template. I guess they were somehow automatically created. Although the Insights, sec. Community of GitHub does encourage to have a PR template and I added it myself to ITK, I am not satisfied with the result: I believe it adds another action to the PR if we want to keep the message clean. Until GitHub does a better job displaying the message outside of the commit message, this PR just adds a notice to users to remember to delete the template text. Suggestions or modifications are welcome. |
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.
Thanks for your attention to this @jhlegarreta .
Another thought: maybe we want to put the file in .github/PULL_REQUEST_TEMPLATE.md
as described here:
https://blog.github.com/2016-02-17-issue-and-pull-request-templates/
?
432f3ea
to
88ef263
Compare
Will move them in a separate topic. Thanks @thewtex. |
The mentioned files are moved in #161. |
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.
Thanks, @jhlegarreta !
The content-check is requesting a newline at the end of the file -- please go ahead with the merge after addressing this.
Improve the PR template message to highlight the fact that it is a set of guidelines that should be removed for the final PR message.
88ef263
to
16a81bb
Compare
16a81bb adds the newline. Thanks for the heads-up Matt. |
The CircleCI build error is unrelated:
Merging. |
Improve the PR template message to highlight the fact that it is a set of
guidelines that should be removed for the final PR message.