Skip to content
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

Conversation

jhlegarreta
Copy link
Member

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.

@jhlegarreta
Copy link
Member Author

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.

Copy link
Member

@thewtex thewtex left a 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/

?

PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
PULL_REQUEST_TEMPLATE.md Outdated Show resolved Hide resolved
@jhlegarreta
Copy link
Member Author

Will move them in a separate topic. Thanks @thewtex.

@jhlegarreta
Copy link
Member Author

The mentioned files are moved in #161.

@jhlegarreta jhlegarreta changed the title DOC: Advice users to delete the PR template in message. DOC: Advise users to delete the PR template in message. Nov 9, 2018
Copy link
Member

@thewtex thewtex left a 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.
@jhlegarreta
Copy link
Member Author

16a81bb adds the newline. Thanks for the heads-up Matt.

@hjmjohnson hjmjohnson self-requested a review November 10, 2018 01:39
@jhlegarreta
Copy link
Member Author

The CircleCI build error is unrelated:
itkImageRandomNonRepeatingIteratorWithIndexTest (Failed)

Iterator in priority region test failed
[17, 19, 17] is outside the region (should be in)ImageRegion (0x7ffd1b8d1100)
  Dimension: 3
  Index: [0, 0, 0]
  Size: [50, 50, 50]

Merging.

@jhlegarreta jhlegarreta merged commit 6f5bdab into InsightSoftwareConsortium:master Nov 10, 2018
@jhlegarreta jhlegarreta deleted the AdviceUsersToDeletePRTemplate branch November 10, 2018 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants