-
Notifications
You must be signed in to change notification settings - Fork 161
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
Remove template for GitHub pull requests #1154
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1154 +/- ##
==========================================
- Coverage 59.24% 59.23% -0.01%
==========================================
Files 434 434
Lines 231096 231096
==========================================
- Hits 136904 136899 -5
- Misses 94192 94197 +5
Continue to review full report at Codecov.
|
I am perfectly happy with people just removing the template text and starting to write their own description. But I do think that the template is useful, especially for new contributors, and for changes that are worth describing in release notes, so I don't want to see it gone completely. I've used it myself in #1144 and find it helpful. However, I agree that it's annoying that it is too long, and it will be useful to squeeze it. For example:
|
I don't think that second section is useful at all. First off, it requires the submitter to know (or decide?) whether the PR should be listed in the releases notes. This is already where it goes wrong, IMHO. Of course these are not applied consistently -- just as those checkbox are not consistently checked. |
OK, the 2nd section addresses the following problem: when there is a time to collate all descriptions for the release announcement, many of them are either missing or written informally, and it requires more efforts to put them together than it should be. An alternative is to drop that completely, and refer to the list of issues/PRs under release milestone, but that would contain a lot of noise (see e.g. here for coming GAP 4.9). I agree with the argument that it may be not known to the submitted in advance. So asking for a description and checkboxes could be moved to one of the "saved replies" to be asked later. The label "for-release-notes" sounds like a good alternative idea. So, shall we then reduce the template to have a last-minute reminder about correct branch and also about tests?
If there is a strong support for deleting this template completely, please go ahead - I will not merge this myself though ;-) |
I used the template exactly once, and I recall that it took too much time (relatively) to fill it out. In all other cases I just got annoyed and removed all text. |
So, shall we leave just this text then?
|
To be completely honest, I am still in favour of just removing the template entirely. |
Ok, fine. We can always restore it if need be. But we do must keep some checklist and maintain discipline while merging PRs: branch, tests, description, closing related issues, etc. |
Please make sure that this pull request:
Tick all what applies to this pull request
Write below the description of changes (for the release notes)
This PR removes our template for GitHub PRs. I find that template useless, and always remove it when submitting a PR. This one is an exception, to demonstrate what the template looks like, and also to remind of the fact that information in it need not be accurate anyway: You must check whether a branch was submitted to the right branch anyway -- if we want to keep track of that, let's use a label. Most other checkboxes can also be handeled by labels.
And finally, if information is missing in a PR, we just ask for it (if we keep asking the same questions, we can start using "Saved Replies", see https://help.github.com/articles/working-with-saved-replies/