This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 656237e1db [INLONG-943][Github] Improve the pull request template
(#944)
656237e1db is described below
commit 656237e1dbb2b2125b1279158489ad2adc67ef60
Author: AloysZhang <[email protected]>
AuthorDate: Thu Apr 25 19:15:30 2024 +0800
[INLONG-943][Github] Improve the pull request template (#944)
---
.github/PULL_REQUEST_TEMPLATE.md | 34 ++++++++++++++++------------------
1 file changed, 16 insertions(+), 18 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 5737eefe11..b0a4082e23 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,19 +1,20 @@
-### Prepare a Pull Request
-*(Change the title refer to the following example)*
+<!-- Prepare a Pull Request
+Change the title of pull request refer to the following example:
+ [INLONG-XYZ][Component] Title of the pull request
+-->
-- Title Example: [INLONG-XYZ][Component] Title of the pull request
+<!-- Specify the issue this pull request going to fix.
+The following *XYZ* should be replaced by the actual [GitHub
Issue](https://github.com/apache/inlong/issues) number)-->
-*(The following *XYZ* should be replaced by the actual [GitHub
Issue](https://github.com/apache/inlong/issues) number)*
-
-- Fixes #XYZ
+Fixes #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
@@ -21,19 +22,16 @@
*(Please pick either of the following options)*
-This change is a trivial rework / code cleanup without any test coverage.
-
-*(or)*
-
-This change is already covered by existing tests, such as *(please describe
tests)*.
+- [ ] This change is a trivial rework/code cleanup without any test coverage.
-*(or)*
+- [ ] This change is already covered by existing tests, such as:
+ *(please describe tests)*
-This change added tests and can be verified as follows:
+- [ ] This change added tests and can be verified as follows:
-*(example:)*
- - *Added integration tests for end-to-end deployment with large payloads
(10MB)*
- - *Extended integration test for recovery after broker failure*
+ *(example:)*
+ - *Added integration tests for end-to-end deployment with large payloads
(10MB)*
+ - *Extended integration test for recovery after broker failure*
### Documentation
