aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/git/commit-msg-template
blob: 6d72af12665cd0853720ae26ac1d2f4074053236 (plain)
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
# <type>: (if applied, this commit will...) <subject> (Max 50 chars)
# |<---- Using a Maximum Of 50 Characters  ---->|


# Explain why this change is being made
# |<----   Try To Limit Each Line to a Maximum Of 72 Characters   ---->|

# Provide links or keys to any relevant tickets, articles or other resources
# Example: Github issue #23

# --- COMMIT END ---
# Type can be
#    Feat     (new feature)
#    Fix      (bug fix)
#    Refactor (refactoring production code)
#    Style    (formatting, missing semi colons, etc; no code change)
#    Docs     (changes to documentation)
#    Test     (adding or refactoring tests; no production code change)
#    Chore    (updating grunt tasks etc; no production code change)
# --------------------
# Remember to
#    Choose one of types above in 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 "-" for bullet points in body
# --------------------