-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path.gitmessage
executable file
·37 lines (32 loc) · 1.45 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
# Header (mandatory)
# <type>[optional scope]: <short summary>
# |<---- Using a Maximum Of 50 Characters ---->|
# Body (optional)
# Explain what, and why this change is being made
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# Footer (optional)
# Provide links or keys to any relevant tickets, articles or other resources
# Example: Closes #1, fixes #2, resolves #3
# Breaking changes should start with the word "BREAKING CHANGES:" followed by space
# Example: BREAKING CHANGES: config filename changed
# --- COMMIT END ---
# Type can be
# build (affects build components, e.g. ci pipeline, dependencies)
# chore (miscellaneous changes, e.g. modifying .gitignore)
# docs (changes to documentation)
# feat (new feature)
# fix (bug fix)
# perf (refactor commit that improves performance)
# refactor (rewrite/restructure code that does not change behaviour)
# style (formatting, missing semi colons, etc; no code change)
# test (adding or correcting tests)
# --------------------
# Remember to
# - Use the imperative, present tense: "change" not "changed" nor "changes"
# - Don't capitalize the subject line
# - Don't end the subject line with a period
# - Separate subject from body with a blank line
# - Separate body from footer with a blank line
# - Use the body to explain what and why vs. how
# - Can use multiple lines with "-" for bullet points in body
# --------------------