-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path.gitmessage
53 lines (49 loc) · 2.09 KB
/
.gitmessage
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
# [<tag>] (If applied, this commit will...) <subject> (Max 72 char)
# |<---- Preferably using up to 50 chars --->|<------------------->|
# Example:
# [feat] Implement automated commit messages
# (Optional) <body>: Explain why this change is being made
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# (Note) if <tag> == fix: (briefly or in detail)
# [<problem>]: Describe the problem and how did it happen.
# [<solution>]: Describe the solution
# Example:
# [problem] unexpected input
# expected <str>, got <None>
# the problem is generated by user.
# [solution]
# * assertion check
# * exception handling
# (Optional) Provide links or keys to any relevant tickets, articles or other resources
# Example: Github issue #23
# --- COMMIT END ---
# Tag can be
# add (new files)
# feat (new feature)
# fix (bug fix)
# refactor (refactoring code)
# style (formatting, missing semi colons, etc; no code change)
# docs (changes to documentation)
# perf (preformance optimization or profiling)
# test (adding or refactoring tests; no production code change)
# build (build related events)
# version (version bump/new release; no production code change)
# dbg (Changes in debugging code/frameworks; no production code change)
# license (Edits regarding licensing; no production code change)
# ci (CI setting)
# 3rd (add 3rd-party packages)
# hack (Temporary fix to make things move forward; please avoid it)
# WIP (Work In Progress; for intermediate commits to keep patches reasonably sized)
# misc (Miscellaneous stuff)
# defaults (changes default options)
#
# Note: Multiple tags can be combined, e.g. [fix][test] Fix issue X unittest
# --------------------
# Remember to:
# * Capitalize the subject line
# * Use the imperative mood in the subject line
# * Do not end the subject line with a period
# * Separate subject from body with a blank line
# * Use the body to explain what and why vs. how
# * Can use multiple lines with "-" or "*" for bullet points in body
# --------------------