[GitHub] [spark] HyukjinKwon opened a new pull request #25310: [SPARK-28578][INFRA] Improve Github pull request template

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

HyukjinKwon opened a new pull request #25310: [SPARK-28578][INFRA] Improve Github pull request template
URL: https://github.com/apache/spark/pull/25310
 
 
   <!--  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 ran the appropriate tests for your PR: http://spark.apache.org/developer-tools.html
   3. If the PR is unfinished, add `[WIP]` in your PR title.
   4. Update your PR description whenever it is needed.
   -->
   
   ### What changes were proposed in this pull request?
   
   This PR proposes to improve the Github template for better and faster review iterations and better interactions between PR authors and reviewers.
   
   As suggested in the the [dev mailing list](http://apache-spark-developers-list.1001551.n3.nabble.com/DISCUSS-New-sections-in-Github-Pull-Request-description-template-td27527.html), this PR referred [Kubernates' PR template](https://raw.githubusercontent.com/kubernetes/kubernetes/master/.github/PULL_REQUEST_TEMPLATE.md).
   
   Therefore, those fields are newly added:
   
   ```
   ### Why changes are needed?
   ### Special notes for your reviewer
   ### Does this PR introduce any user-facing change?
   ```
   
   and some comments were added.
   
   ### Why changes are needed?
   
   Currently, many PR descriptions are poorly formatted, which causes some overheads between PR authors and reviewers.
   
   There are multiple problems by those poorly formatted PR descriptions:
   
   - Some PRs still write single line in PR description for with 500+- code changes.
   - Some PRs do not describe behaviour changes and reviewers need to find and document.
   - Some PRs are hard to review without outlines but they are not mentioned sometimes.
   - Spark is being old and sometimes we need to track the history deep. Due to poorly formatted PR description,  sometimes it requires to read whole codes of whole commit histories to find the root cause of a bug.
   - Reviews take awhile but the number of PR still grows.
   
   This PR targets to alleviate the problems and situation.
   
   ### Special notes for your reviewer
   <!--
   This special notes can be any notes for reviewers to review faster and more efficiently.
   For instance,
     - if you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
     - if you fix some SQL features, you can provide some references of other DBMSes.
     - if this is a design documentation, please leave the link.
     - if there is a discussion in the mailing thread, please leave the link.
   -->
   
   - Discussion link: http://apache-spark-developers-list.1001551.n3.nabble.com/DISCUSS-New-sections-in-Github-Pull-Request-description-template-td27527.html
   - Kubernates PR template: https://raw.githubusercontent.com/kubernetes/kubernetes/master/.github/PULL_REQUEST_TEMPLATE.md
   
   
   ### Does this PR introduce any user-facing change?
   <!--
   If yes, please clarify the previous behavior and the change this PR proposes. Also, please provide the console output, description and/or the reproducer to test if possible so that reviewers can review this patch faster.
   If no, write 'No'.
   -->
   
   Yes, it changes the PR templates when PRs are open. This PR uses the template this PR proposes.
   
   ### How was this patch tested?
   <!--
   If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check through, and descendants can verify in the future.
   -->
   
   Manually tested via Github preview feature.
   

----------------------------------------------------------------
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