-
Notifications
You must be signed in to change notification settings - Fork 0
/
.gitmessage
36 lines (32 loc) · 1.37 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
# Finish this sentence: "If applied, this commit will...".
# <type>: <subject>
# |<--- Max 50 --->|
# Why is this change being made?
# |<--- Max 72 --->|
# Provide any relevant references.
# --- END ---
# Commit Types:
# feat (a new feature)
# fix (a bug fix)
# docs (documentation only changes)
# style (changes that do not affect the meaning of the code)
# ref (refactor; a code change that neither fixes a bug nor adds a feature)
# perf (a code change that improves performance)
# test (adding missing tests or correcting existing tests)
# build (changes that affect the build system or external dependencies)
# ci (changes to our CI configuration files and scripts)
# chore (other changes that don't modify src or test files)
# revert (reverts a previous commit)
# -----------
# The Seven Rules
# 1. Separate subject from body with a blank line
# 2. Limit the subject line to 50 characters
# 3. Capitalize the subject line
# 4. Do not end the subject line with a period
# 5. Use the imperative mood in the subject line
# 6. Wrap the body at 72 characters
# 7. Use the body to explain what and why vs. how
# -----------
# References
# https://github.com/commitizen/conventional-commit-types/blob/master/index.json
# https://chris.beams.io/posts/git-commit/#seven-rules