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

improve the pull request template #37651

Closed
wants to merge 1 commit into from

Conversation

l29ah
Copy link
Contributor

@l29ah l29ah commented Feb 2, 2020

to simplify the mandatory summary specification

Summary

SUMMARY: None

Purpose of change

Describe the solution

Describe alternatives you've considered

Testing

Additional context

@ZhilkinSerg ZhilkinSerg added Organization General development organization issues [Markdown] Markdown issues and PRs labels Feb 2, 2020
@Brian-Otten
Copy link
Contributor

The old one has been driving me batty for a while now so this is appreciated.

Copy link
Member

@kevingranade kevingranade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops buried.
So the reason there isn't a valid summary line in the template is so if you don't edit it, it will fail the summary checker.

I see three valid options:
There is no valid summary line in the template as it is now,.
There is a SUMMARY: None line in the template so your PR is IGNORED in the changelog unless you edit it (but then there is no example of what to do?)
There is a SECOND summary line or some other kind of poison pill that must be edited away to make the PR description pass the summary checker.

Erk's suggestion is a version of the third, it's a summary line ready for you to edit, but it's not a valid summary line. The problem there is that it is inside a comment, so if someone simply edits it in place it will pass the checker but not have a visible summary.

to simplify the mandatory summary specification
@l29ah
Copy link
Contributor Author

l29ah commented Feb 23, 2020

Okay.

@kevingranade
Copy link
Member

You did literally BOTH of the things I said not to do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Markdown] Markdown issues and PRs Organization General development organization issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants