[pulsar] branch master updated: [improve][misc] Pull request template (#17545)

[lh...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

lhotari pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new 4ec338d6663 [improve][misc] Pull request template (#17545)
4ec338d6663 is described below

commit 4ec338d6663cd2aa9e79c5c9e0d317abc6929bdd
Author: tison <wa...@gmail.com>
AuthorDate: Fri Sep 9 13:33:47 2022 +0800

    [improve][misc] Pull request template (#17545)
    
    * [improve][misc] Pull request template
    
    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.
    
    * Update .github/PULL_REQUEST_TEMPLATE.md
---
 .github/PULL_REQUEST_TEMPLATE.md | 39 +++++++++++++++++----------------------
 1 file changed, 17 insertions(+), 22 deletions(-)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 84223fde56c..c8d670e2618 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.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)**
 -->
 
-*(If this PR fixes a github issue, please add `Fixes #<xyz>`.)*
+<!-- Either this PR fixes an issue, -->
 
 Fixes #<xyz>
 
-*(or if this PR is one task of a github issue, please add `Master Issue: #<xyz>` to link to the master issue.)*
+<!-- or this PR is one task of an issue -->
 
 Master Issue: #<xyz>
 
 ### Motivation
 
-
-*Explain here the context, and why you're making that change. What is the problem you're trying to solve.*
+<!-- Explain here the context, and why you're making that change. What is the problem you're trying to solve. -->
 
 ### Modifications
 
-*Describe the modifications you've done.*
+<!-- Describe the modifications you've done. -->
 
 ### Verifying this change
 
@@ -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 THE PROPER BOX ONLY. -->
 
 - [ ] `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)
\ No newline at end of file
+(Docs have been already added)