[GitHub] [incubator-uniffle] advancedxy commented on a diff in pull request #588: [#551] docs: update templates for flaky test and pull request

["advancedxy (via GitHub)" <gi...@apache.org>]

advancedxy commented on code in PR #588:
URL: https://github.com/apache/incubator-uniffle/pull/588#discussion_r1102498728


##########
.github/PULL_REQUEST_TEMPLATE:
##########
@@ -1,44 +1,34 @@
 <!--
-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://github.com/apache/incubator-uniffle/blob/master/CONTRIBUTING.md
-  2. Ensure you have added or run the appropriate tests for your PR
-  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP]XXXX Your PR title ...'.
-  4. Be sure to keep the PR description updated to reflect all changes.
-  5. Please write your PR title to summarize what this PR proposes.
-  6. If possible, provide a concise example to reproduce the issue for a faster review.
+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://github.com/apache/incubator-uniffle/blob/master/CONTRIBUTING.md
+  2. Please write your PR title to summarize what this PR proposes.
+     The preferred format is: "[#issue] type(scope): summary"
+     If there is no need to link to a issue: "[MINOR] type(scope): summary"
+     For reference: https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716
+  3. If the PR is unfinished, please mark this PR as draft.
 -->
 
 ### 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.
-If possible, please consider writing 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 design documentation, please add the link.
-  4. If there is a discussion in the mailing list, please add the link.
--->
 
+Please outline the changes and how this PR fixes the issue.
 
 ### Why are the changes needed?
-<!--
+
 Please clarify why the changes are needed. For instance,
   1. If you propose a new API, clarify the use case for a new API.
-  2. If you fix a bug, you can clarify why it is a bug.
--->
+  2. If you fix a bug, describe the bug.
 
+Fix: #

Review Comment:
   I know you intention. But contributor may got confused about what this is.



-- 
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: issues-unsubscribe@uniffle.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@uniffle.apache.org
For additional commands, e-mail: issues-help@uniffle.apache.org