-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgit-commit-message.txt
41 lines (30 loc) · 1.48 KB
/
git-commit-message.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
<type>(<scope>): <subject>
<body>
<footer>
#Any line of the commit message cannot be longer 100 characters.
#### Type
#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, missing semi-colons, 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.
#chore: Changes to the build process or auxiliary tools and libraries such as documentation generation.
#### Scope
#The scope is optional and could be anything specifying
#place of the commit change. For example `nsis`, `mac`, `linux`, etc...
#### Subject
#The subject contains succinct description of the change:
#* use the 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**
#and is also the place to reference GitHub issues that this commit **Closes**.
#**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.
# Adapted from https://gist.github.com/develar/273e2eb938792cf5f86451fbac2bcd51