Update text in PR template #6188
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hugovk
added
the
type: docs
blueyed
reviewed
Nov 14, 2019
| @@ -2,15 +2,14 @@ | |||
| Thanks for submitting a PR, your contribution is really appreciated! | |||
|
|
|||
| Here is a quick checklist that should be present in PRs. | |||
| (please delete this text from the final description, this is just a guideline) | |||
There was a problem hiding this comment.
This might be a misunderstanding then - I've assumed the whole text should be deleted - or at least we should not end up with open TODOs always (since you cannot target both master/features).
Can we have the closing --> at the end maybe, so everything becomes a comment / invisble?
blueyed
approved these changes
Nov 14, 2019
|
Thanks! ❤️ |
|
hmmm if we're going to hide the checklist entirely what's the point? now I can't see if PRs are ready |
|
An argument for hiding the checklist completely: you don't get these inconsistent progress bars.
An argument for keeping it: maintainers can see which tasks have been done.
Would it be best to keep the checklist visible, and something like this in the comment block?
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
masterbranch for bug fixes, documentation updates and trivial changes.featuresbranch for new features, improvements, and removals/deprecations.Unless your change is trivial or a small documentation fix (e.g., a typo or reword of a small section) please:
changelogfolder, with a name like<ISSUE NUMBER>.<TYPE>.rst. See changelog/README.rst for details.AUTHORSin alphabetical order;The "(please delete...)" text is redundant and can be removed; it's inside comments so won't be shown anyway.
Replace the semicolon with a fullstop. It's not necessary here, you don't use them at the end of a sentence; they would only go in the middle of a sentence, a bit like a comma.