Refine PULL_REQUEST_TEMPLATE.md #12749
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| @@ -1,21 +1,27 @@ | |||
| <!-- YOU HAVE TO MODIFY THIS TEXT TO FIT YOUR PR. OTHERWISE, YOUR PR WILL BE CLOSED WITHOUT FURTHER COMMENT. --> | |||
|
|
|||
| Describe the changes you have made here: what, why, ... | |||
| Describe the changes you have made here: what, where, why, ... | |||
| If it is WIP, please open a draft pull request. In that case, outline your intended next steps. Do you need feedback? Will you continue in parallel? ... | |||
There was a problem hiding this comment.
99% of PRs are work in progress. The major difference between Draft and real PR should in theory be something that is deemed mergeable or not, but in practice this fine line is fluid and always will be, because one doesn't know what one doesn't know and a review might bring to light things that was not considered beforehand and that's ok. Draft means, the one that opens the PR has the intention or the knowledge that the PR is not finished yet and will continue to work on it.
The only thing that is required for maintainers is to know when to start a review.
There was a problem hiding this comment.
If it is WIP "If you are not yet sure about your approach -" does this convey it better?
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| <!-- LINK THE ISSUE WITH THE "Closes" KEYWORD --> | ||
| <!-- Example: Closes (link) OR Closes #xyz --> | ||
|
|
||
| ### Mandatory checks | ||
|
|
||
| <!-- | ||
| - Go through the list below. Please don't remove any items. | ||
| - [x] done; [ ] not done / not applicable | ||
| Go throgh the checklist below. It is mandatory, even if you submit a draft pull request. |
There was a problem hiding this comment.
Try to avoid conditional statements. It makes sentences complicated to read.
There was a problem hiding this comment.
| Go throgh the checklist below. It is mandatory, even if you submit a draft pull request. | |
| Go throgh the checklist below. It is mandatory. |
There was a problem hiding this comment.
It is more of an "unconditional" statement. Would this be better:
| Go throgh the checklist below. It is mandatory, even if you submit a draft pull request. | |
| Go throgh the checklist below. It is mandatory, even for a draft pull request. |
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| - Go through the list below. Please don't remove any items. | ||
| - [x] done; [ ] not done / not applicable | ||
| Go throgh the checklist below. It is mandatory, even if you submit a draft pull request. | ||
| For instance, a screenshot helps in reviewing - even if your code is not 100% complete. |
There was a problem hiding this comment.
I still don't like this line. It's too much text that doubles down on a single topic.
| For instance, a screenshot helps in reviewing - even if your code is not 100% complete. |
There was a problem hiding this comment.
Trigger for this was here, so I am guessing idea was to put it somewhere. Keeping this line OR keeping #12749 (comment) would suffice, so I'll apply your suggestion on this one (removal).
|
The build for this PR is no longer available. Please visit https://builds.jabref.org/main/ for the latest build. |
| Keep ALL the items. Mark them as follows: | ||
| [x] done | ||
| [ ] not done | ||
| [/] not applicable |
There was a problem hiding this comment.
[/] is not supported by GitHub:
But I find it helpful to separate n/a from not done ^^
|
don't make it too complicated. Students's won't read it anyways ;) |
Refinement of PULL_REQUEST_TEMPLATE triggered by #12662 (comment) / #12741
CHANGELOG.mddescribed in a way that is understandable for the average user (if change is visible to the user)