-
Notifications
You must be signed in to change notification settings - Fork 0
/
gitmessage
61 lines (60 loc) · 2.08 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
54
55
56
57
58
59
60
61
# [<tag>] (if applied, this commit will ...) <subject>
# |<-- Preferably using up to 50 chars -->|
#
# EXAMPLE
# [feat] Implement automated commit messages
# (Optional) Explain why this change is being made
# |<-- Try To Limit Each Line to Maximum Of 72 Characters -->|
#
# DEFAULTS
# STYLE
#
# --- 80 chars wrap ---
# - This helps in various aspects. One is related to the width of the
# older terminals, which are 80 characters wide. Another is purely on
# humans' ability to read text, lines wider than 80 characters are
# hard to read.
#
# --- typo ---
# - Right spelling is essential to the project's codebase.
#
# DEBUG
# --- remove console.log ---
# - This will log information on user's console, if is not removed.
#
# (Optional) Provide links to any relevant tickets, articles or other resources
# EXAMPLE GitHub issue #23
#
#
# --- COMMIT END ---
#
# Tag can be one of the following
#
# feat ( new feature)
# fix ( bug fix)
# refactor ( refactoring code)
# style ( formatting, missing semi colons, etc; no code change)
# doc ( changes to documentation)
# test ( adding or refactoring test; no production code change)
# version ( version bunp/new release; no production code change)
# dbg ( changes in debugging code/frameworks; no production code change)
# license ( edits regarding licensing; no production change)
# hack ( Temporary fix to make things move forward; please avid it)
# WIP ( Work In Progress; for intermediate commits to keep patches small)
# defaults ( changes default options)
#
#
# Note Multiple tags can be combined, e.g. [fix][defaults] Fix issue X in const
# ------------------
# 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 blank line
# * Use the body to explain what and why vs. how
# * Can use multiple lines with "-" or "*" for bullet points in body
# -----------------
#
# Original source of the template
# "https://gist.github.com/zakkak/7e06725ebd1336bfebebe254de3de825"