Skip to content

Commit 77c5c61

Browse files
authored
[MINOR] improvement(ci): add some examples and notice (#2240)
### What changes were proposed in this pull request? add some examples and notice ### Why are the changes needed? - To show more use case about how to write PR title - Notice contributors to remove all the generated comments before review request.
1 parent 44dff5f commit 77c5c61

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

.github/PULL_REQUEST_TEMPLATE

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1+
# NOTICE: Please remove all these generated template comments before request review(include this line)
2+
13
<!--
24
1. Title: [#<issue>] <type>(<scope>): <subject>
35
Examples:
46
- "[#123] feat(operator): support xxx"
7+
- "[#123] feat(server,coordinator): support xxx"
8+
- "[#123] feat(common): support xxx"
9+
- "[MINOR] improvement(script): fix style"
10+
- "[MINOR] improvement(ci): add some examples and notice"
511
- "[#233] fix: check null before access result in xxx"
12+
- "[#233][FOLLOWUP] improvement(dashboard): display something xxx"
613
- "[MINOR] refactor: fix typo in variable name"
714
- "[MINOR] docs: fix typo in README"
815
- "[#255] test: fix flaky test NameOfTheTest"
@@ -13,27 +20,30 @@
1320
-->
1421

1522
### What changes were proposed in this pull request?
16-
23+
<!--
1724
(Please outline the changes and how this PR fixes the issue.)
25+
-->
1826

1927
### Why are the changes needed?
20-
28+
<!--
2129
(Please clarify why the changes are needed. For instance,
2230
1. If you propose a new API, clarify the use case for a new API.
2331
2. If you fix a bug, describe the bug.)
2432

2533
Fix: # (issue)
34+
-->
2635

2736
### Does this PR introduce _any_ user-facing change?
28-
37+
<!--
2938
(Please list the user-facing changes introduced by your change, including
3039
1. Change in user-facing APIs.
3140
2. Addition or removal of property keys.)
32-
41+
-->
3342
No.
3443

3544
### How was this patch tested?
36-
45+
<!--
3746
(Please test your changes, and provide instructions on how to test it:
3847
1. If you add a feature or fix a bug, add a test to cover your changes.
3948
2. If you fix a flaky test, repeat it for many times to prove it works.)
49+
-->

0 commit comments

Comments
 (0)