-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.gitcommitrules
More file actions
81 lines (56 loc) 路 2.23 KB
/
Copy path.gitcommitrules
File metadata and controls
81 lines (56 loc) 路 2.23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
++++++++++++++++++++++ Git Commit Rules: ++++++++++++++++++++++
Description:
Unify all the commit message to rule and clear it. It could help developers to clean
and write the summary of release version from ALL the commit logs. Any commit with
invalid message format should not be merged or fetched, etc.
Format:
[commit topic] (commit scope) <commit message>
Commit Topic:
* 馃帀馃帄馃嵕 New Feature
The new features which be added currently.
* 馃敡鈿欙笍馃敥 Breaking Change
Modify codes which probably lead to it couldn't run with old version code finely.
* 馃鈿欙笍馃敡 Performance
Improve any performance in anywhere of this package. It may be just a for loop, a
searching mechanism or something else.
* 馃洜馃悰馃挘 Bug Fix
Fix any issues in this package. But it's also probably testing codes.
* 馃敩馃И馃К Refactor
Refactoring code. Sometimes, the others may lead to do it. For example, you need to
fix some issues or modify something to let it's clear so that you would adjust the
software architecture. About that scenario, you should mark as 'Performance + Refactor'
or 'Performance + Bug Fix'.
* 馃懆鈥嶐煆煈擲tyle
Modify anything which does NOT effect to any features or codes. For example, below are
the things of 'Style':
- Remove or add place, indentation, etc.
- Remove or add newline.
- The way to comment out code.
* 馃敩馃尅馃拤Test
Modify any the codes which is testing code for this package. In this package, it's
the directory './tests'.
* 馃懆鈥嶐煉火煍庰煇汥ebug
Modify any the codes or configuration which for debugging. However, it CAN NOT be used
in some scope like 'code' or 'test'.
* 馃摑馃搼馃摋Docs
Modify anything which is related with documentation of this package. In this package,
it's the directory './docs'.
Commit Scope:
* code
Path is './multirunnable'.
* test
Path is './tests'.
* script
Path is './scripts'.
* example
Path is './example'.
* study
Path is './study'.
* docs
Path is './docs'.
* config
Other paths which is not in above, all is config type file.
Commit Message:
The description of your commit. Remember, it's BRIEF or SUMMARY, not DETAIL. Just for the point.
++++++++++++++++++++++ Author & Copyright: ++++++++++++++++++++++
Copyright 2022 Bryant Liu