You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/09/08 09:11:50 UTC
[GitHub] [pulsar] tisonkun opened a new pull request, #17545: [improve][misc] Pull request template
tisonkun opened a new pull request, #17545:
URL: https://github.com/apache/pulsar/pull/17545
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.
### Documentation
- [ ] `doc-required`
(Your PR needs to update docs and you will update later)
- [x] `doc-not-needed`
(Please explain why)
- [ ] `doc`
(Your PR contains doc changes)
- [ ] `doc-complete`
(Docs have been already added)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17545: [improve][misc] Pull request template
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17545:
URL: https://github.com/apache/pulsar/pull/17545#discussion_r966547393
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -53,31 +50,29 @@ This change added tests and can be verified as follows:
### Does this pull request potentially affect one of the following parts:
-*If `yes` was chosen, please highlight the changes*
+*If the box was checked, please highlight the changes*
- - Dependencies (does it add or upgrade a dependency): (yes / no)
- - The public API: (yes / no)
- - The schema: (yes / no / don't know)
- - The default values of configurations: (yes / no)
- - The wire protocol: (yes / no)
- - The rest endpoints: (yes / no)
- - The admin cli options: (yes / no)
- - Anything that affects deployment: (yes / no / don't know)
+- [ ] Dependencies (add or upgrade a dependency)
+- [ ] The public API
+- [ ] The schema
+- [ ] The default values of configurations
+- [ ] The binary protocol
+- [ ] The REST endpoints
+- [ ] The admin CLI options
+- [ ] Anything that affects deployment
### Documentation
-Check the box below or label this PR directly.
-
-Need to update docs?
+**DO NOT REMOVE THIS SECTION. CHECK PROPER BOX ONLY.**
Review Comment:
```suggestion
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] lhotari merged pull request #17545: [improve][misc] Pull request template
Posted by GitBox <gi...@apache.org>.
lhotari merged PR #17545:
URL: https://github.com/apache/pulsar/pull/17545
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on pull request #17545: [improve][misc] Pull request template
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #17545:
URL: https://github.com/apache/pulsar/pull/17545#issuecomment-1240446840
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17545: [improve][misc] Pull request template
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17545:
URL: https://github.com/apache/pulsar/pull/17545#discussion_r966547457
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -53,31 +50,29 @@ This change added tests and can be verified as follows:
### Does this pull request potentially affect one of the following parts:
-*If `yes` was chosen, please highlight the changes*
+*If the box was checked, please highlight the changes*
- - Dependencies (does it add or upgrade a dependency): (yes / no)
- - The public API: (yes / no)
- - The schema: (yes / no / don't know)
- - The default values of configurations: (yes / no)
- - The wire protocol: (yes / no)
- - The rest endpoints: (yes / no)
- - The admin cli options: (yes / no)
- - Anything that affects deployment: (yes / no / don't know)
+- [ ] Dependencies (add or upgrade a dependency)
+- [ ] The public API
+- [ ] The schema
+- [ ] The default values of configurations
+- [ ] The binary protocol
+- [ ] The REST endpoints
+- [ ] The admin CLI options
+- [ ] Anything that affects deployment
### Documentation
-Check the box below or label this PR directly.
-
-Need to update docs?
+**DO NOT REMOVE THIS SECTION. CHECK PROPER BOX ONLY.**
Review Comment:
Addressed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] lhotari commented on a diff in pull request #17545: [improve][misc] Pull request template
Posted by GitBox <gi...@apache.org>.
lhotari commented on code in PR #17545:
URL: https://github.com/apache/pulsar/pull/17545#discussion_r966331554
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -53,31 +50,29 @@ This change added tests and can be verified as follows:
### Does this pull request potentially affect one of the following parts:
-*If `yes` was chosen, please highlight the changes*
+*If the box was checked, please highlight the changes*
- - Dependencies (does it add or upgrade a dependency): (yes / no)
- - The public API: (yes / no)
- - The schema: (yes / no / don't know)
- - The default values of configurations: (yes / no)
- - The wire protocol: (yes / no)
- - The rest endpoints: (yes / no)
- - The admin cli options: (yes / no)
- - Anything that affects deployment: (yes / no / don't know)
+- [ ] Dependencies (add or upgrade a dependency)
+- [ ] The public API
+- [ ] The schema
+- [ ] The default values of configurations
+- [ ] The binary protocol
+- [ ] The REST endpoints
+- [ ] The admin CLI options
+- [ ] Anything that affects deployment
### Documentation
-Check the box below or label this PR directly.
-
-Need to update docs?
+**DO NOT REMOVE THIS SECTION. CHECK PROPER BOX ONLY.**
Review Comment:
Could this be in a markdown comment?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17545: [improve][misc] Pull request template
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17545:
URL: https://github.com/apache/pulsar/pull/17545#discussion_r965709301
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -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)**
Review 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org