Skip to content

Commit dfcb9cd

Browse files
committed
[New Feature + Style] (config) Add the rules of git commit.
1 parent 3d19c2d commit dfcb9cd

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

.gitcommitrules

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

0 commit comments

Comments
 (0)