maskit commented on a change in pull request #3252: [dev] PIP 27: Add checklist 
in github pull request template
URL: https://github.com/apache/pulsar/pull/3252#discussion_r244149112
 
 

 ##########
 File path: .github/PULL_REQUEST_TEMPLATE.md
 ##########
 @@ -1,12 +1,62 @@
+<--
+### Contribution Checklist
+  
+  - Name the pull request in the form "[component] Title of the pull request". 
Skip *component* if you are unsure about which is the best component. E.g. 
`[docs] Fix typo in produce method`.
+
+  - Fill out the template below to describe the changes contributed by the 
pull request. That will give reviewers the context they need to do the review.
+  
+  - Make sure that the change passes the CI checks.
+
+  - Each pull request should address only one issue, not mix up code from 
multiple issues.
+  
+  - 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.
 
 Review comment:
   > No I mean all the CI checks of the PR are green.
   
   A PR is not created and CI checks are not run yet when a contributor read 
it. To remove the (invisible) checklist AFTER all items of the checklist are 
addressed, the contributor need to edit the PR's description. I don't think 
contributors do it. This is a reason I suggested using actual check box.
   
   Maybe we can say "all PRs need to pass all CI checks" as a note instead of 
having it as an item of the check list if it's just a reminder.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

Reply via email to