forked from Stephen-RA-King/piptools-sync
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.gitmessage
59 lines (46 loc) · 2.24 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Title: Summary, imperative, start upper case, don't end with a period
# No more than 50 chars. #### 50 chars is here: #
# Remember blank line between title and body.
# Body: Explain *what* and *why* (not *how*). Include task ID (Jira issue).
# Wrap at 72 chars. ################################## which is here: #
# Commitizen and Python Semantic Release require the following:
# ------------------------------------------------------------
# Each commit message consists of a header, a body and a footer.
# The header has a special format that includes a type, a scope and a subject:
# <type>(<scope>): <subject>
# <BLANK LINE>
# <body>
# <BLANK LINE>
# <footer>
# The header is mandatory and the scope of the header is optional.
# - Revert -
# If the commit reverts a previous commit, it should begin with revert: , followed by
# the header of the reverted commit. In the body it should say: This reverts
# commit <hash>., where the hash is the SHA of the commit being reverted.
# - 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..)
# refactor: A code change that neither fixes a bug nor adds a feature
# perf: A code change that improves performance
# test: Adding missing or correcting existing tests
# chore: Changes to the build process or auxiliary tools and libraries etc.
# - Scope -
# The scope could be anything specifying place of the commit change.
# You can use * when the change affects more than a single scope.
# - 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 issues that this commit closes.
# e.g. Closes #123, #245, #992
# 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.