[GitHub] [spark] gaborgsomogyi commented on a change in pull request #25310: [SPARK-28578][INFRA] Improve Github pull request template

[GitBox <gi...@apache.org>]

gaborgsomogyi commented on a change in pull request #25310: [SPARK-28578][INFRA] Improve Github pull request template
URL: https://github.com/apache/spark/pull/25310#discussion_r311065678
 
 

 ##########
 File path: .github/PULL_REQUEST_TEMPLATE
 ##########
 @@ -1,10 +1,40 @@
-## What changes were proposed in this pull request?
+<!--
+Thanks for sending a pull request!  Here are some tips for you:
+  1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
+  2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
+  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
+  4. Update your PR description whenever it is needed.
+  5. Provide a concise example to reproduce the issue if possible for a faster review.
+-->
 
-(Please fill in changes proposed in this fix)
+### What changes were proposed in this pull request?
+<!--
+Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. 
+Therefore, if possible, please consider write some useful notes for better and faster reviews in your PR. See the examples below.
+  1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
+  2. If you fix some SQL features, you can provide some references of other DBMSes.
+  3. If there is a design documentation, please leave the link.
+  4. If there is a discussion in the mailing list, please leave the link.
+-->
 
-## How was this patch tested?
 
-(Please explain how this patch was tested. E.g. unit tests, integration tests, manual tests)
-(If this patch involves UI changes, please attach a screenshot; otherwise, remove this)
+### Why are the changes needed?
 
 Review comment:
   This chapter answers the `what and why to solve?` questions but I personally always look for something `how is it solved high level`. If the high level approach is questionable it worth to wait with the deep dive.

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org