Skip to content

Commit 84e6778

Browse files
committed
[New Feature] (config) Add a new template content with markdown for PR. [skip ci]
1 parent dfcb9cd commit 84e6778

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#### Pre-Checking
2+
3+
‼️Please must read this section and check by yourself.
4+
⚠️Do NOT modify this section if it doesn't have any necessary reason.
5+
6+
Please verify the PR header should be satisfied below format:
7+
8+
[commit topic] (commit scope) <commit summary>
9+
10+
* commit topic: The major topic of your modify. It could have multiple topics, e.g., [Breaking Change + Test].
11+
* commit scope: The scope in project of modify. It could have multiple scopes, e.g., (config + test).
12+
* commit summary: Summary of the commits. It should be clear that the target, the KEY POINT why you modify it or what you resolve, etc.
13+
14+
Please refer to [GCR (Git Commit Rules) of SmoothCrawler-Cluster](../../.gitcommitrules) to get more detail about it.
15+
16+
<hr>
17+
18+
### _Target_
19+
20+
* The target why you modify something.
21+
22+
23+
### _Modify Code Scope_
24+
25+
* The more details of project scope which be modified, e.g., (refer to below 2 example items)
26+
* Which sub-packages or modules or objects or functions, etc., in **source code**.
27+
* Which sub-packages or modules or objects or functions, etc., in **test**.
28+
29+
30+
### _Effecting Scope_
31+
32+
* What's the scope in project it would affect with your modify? The format could refer to previous one section.
33+
34+
35+
### _Description_
36+
37+
* the summary of your modify ...

0 commit comments

Comments
 (0)