[improve][misc] Pull request template #17545
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
|
cc @Anonymitaet cc @lhotari I think we may ask contributors to run personal CI in the PR template. But I don't find a nice wording yet. Since @github doesn't support form format to PR template like issue template, we should keep the template tidy or easy to follow. Otherwise as current status, few people will spend time to fill it. |
tisonkun
commented
Sep 8, 2022
| @@ -10,26 +10,23 @@ | |||
| - Each commit in the pull request has a meaningful commit message | |||
|
|
|||
| - Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below. | |||
|
|
|||
| **(The sections below can be removed for hotfixes of typos)** | |||
There was a problem hiding this comment.
This is not true. We should retain the documentation section since it's read by actions. Also, I tend not to open the door for "hotfixes". If the change is trivial, taking some time to go through the template doesn't hurt, as long as the template is concise.
BewareMyPower
approved these changes
Sep 8, 2022
1. Highlight to retain the documentation section so that committers can correct it if necessary simply with UI. 2. Few people edit the "affect one of the following parts". Change it to checkboxes for easily applying. 3. Comment out some placeholder.
nicoloboschi
force-pushed
the
patch-2
branch
from
4df1e67 to
b1b519d
Compare
lhotari
requested changes
Sep 8, 2022
RobertIndie
approved these changes
Sep 9, 2022
Anonymitaet
approved these changes
Sep 9, 2022
lhotari
approved these changes
Sep 9, 2022
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.
Documentation
doc-required(Your PR needs to update docs and you will update later)
doc-not-needed(Please explain why)
doc(Your PR contains doc changes)
doc-complete(Docs have been already added)