-
Notifications
You must be signed in to change notification settings - Fork 0
/
.git-commit-message-template.txt
62 lines (57 loc) · 2.06 KB
/
.git-commit-message-template.txt
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
62
# id:<id> <type>(<scope>): (If applied, this commit will) <subject>
# id:12345 feat(login): add password enforcement
# |<---- Subject is maximum 50 Characters ---->|
# <body>
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# <footer>
# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->|
# --- COMMIT END ---
# http://bit.ly/1MmY9Nj
#
# Remember
# Do NOT capitalise the first letter in subject line
# Do NOT end the subject line with a period
# Do NOT exceed 100 character per line
#
# Do add TPO id
# Do use the imperative mood in the subject line
# Do Separate subject from body with a blank line
# Do use the body to explain what and why vs. how
# Do use multiple lines with "-" for bullet points in body
#
# -- Type --
# Must be one of the following:
#
# feat: A new feature
# fix: A bug fix
# docs: Documentation only changes
# style: Changes that do not affect the meaning of the code
# (white-space, formatting etc)
# 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, CI or external deps
# (gulp, broccoli, npm)
# chore: Other changes that don't modify src or test files
#
# -- Scope --
# The scope could be anything specifying place of the commit change.
# For example Compiler, ElementInjector, etc.
#
# -- Subject --
# The subject contains a succinct description of the change:
# use imperative, present tense: "change" not "changed" nor "changes"
# don't capitalize first letter
# no dot (.) at the end
#
# -- Body --
# Just as in the subject, use the imperative,
# present tense: "change" not "changed" nor "changes".
# The body should include the motivation for the change and contrast
# this with previous behavior.
#
# -- Footer --
# The footer should contain any information about Breaking Changes.
# Breaking Changes should start with the word BREAKING CHANGE:
# with a space or two newlines.
# The rest of the commit message is then used for this.