-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdot_gitmessage
196 lines (183 loc) · 6.34 KB
/
dot_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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<type>(<scope>): <summary>, 50 chars ------------|
<Describe the motivation behind this change, explain WHY you are making
this change. Wrap all lines at 72 characters.>
<BREAKING CHANGE: <summary>, wrap at 72 chars>
<Describe the breaking change and migration instructions>
<Fixes #issue-number>
# ---------------------------- 72 chars -------------------------------|
# Commit Messages Examples
# ========================
# --- Simple feature --------------------------------------------------|
# feat: add email notifications on new direct messages
# ---------------------------------------------------------------------|
# --- Simple feature with scope ---------------------------------------|
# feat(shopping cart): add the amazing button
# ---------------------------------------------------------------------|
# --- Feature with breaking change ------------------------------------|
# feat!: allow provided config object to extend other configs
#
# BREAKING CHANGE: `extends` key in config file is now used for
# extending other config files
# ---------------------------------------------------------------------|
# --- Breaking Change with issue reference ----------------------------|
# chore!: drop support for Node 6
#
# BREAKING CHANGE: use JavaScript features not available in Node 6.
#
# Fixes #123
# ---------------------------------------------------------------------|
# --- Simple docs change ----------------------------------------------|
# docs: correct spelling of CHANGELOG
# ---------------------------------------------------------------------|
# --- Simple refactor -------------------------------------------------|
# refactor: implement fibonacci calculation as recursion
# ---------------------------------------------------------------------|
# --- A bug fix with complete commit message --------------------------|
# fix: prevent racing of requests
#
# Introduce a request id and a reference to latest request. Dismiss
# incoming responses other than from latest request.
#
# Remove timeouts which were used to mitigate the racing issue but are
# obsolete now.
#
# Fixes #325
# ---------------------------------------------------------------------|
# Commit Guidelines
# =================
#
# Inspired in Conventional Commits and Angular Guidelines.
#
# Each commit message of a *header*, a *body* and a *footer* as in:
#
# ```
# <header>
# <BLANK LINE>
# <body>
# <BLANK LINE>
# <footer>
# ```
#
# The header is mandatory and must preferably contain 50 characters.
#
# The body is optional but is a great way to explain the motivation for
# the change.
#
# The footer is optional.
#
# Any line in commit body cannot be longer than 72 characters.
#
# Commit Message Header
# ---------------------
#
# The header must have the format:
#
# <type>(<scope><!>): <short summary>
# │ │ │ │
# │ │ │ └─ Summary in present tense, not capitalized
# │ │ │ and no period at the end
# │ │ │
# │ │ └─ Breaking changes signal is optional
# │ │
# │ └─ Scope is optional and is a noun that represents a section
# │ of the codebase like core, data, infra, app, web, mobile
# │
# └─ Type reveals the intetion of the change in the codebase. Could it
# be: build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test|
# wip
#
# ##### Type
#
# Must be one of the following:
#
# * build: change the build system or external dependencies
# * chore: change the tools and libraries configuration
# * ci: change the CI configuration files and scripts
# * docs: edit the documentation
# * feat: add a new feature
# * fix: patch a bug
# * perf: optimize performance with a code change
# * refactor: modify code but no fixes or new features
# * revert: revert to a previous commit
# * style: modify code without affecting its meaning
# * test: add missing or correct existing tests
# * wip: mark a feature branch as work in progress
#
# ##### Scope
#
# The scope should be the name of a section of the codebase such as core,
# domain, data, web, changelog, readme, infra, among others.
#
# ##### Summary
#
# Use the summary to provide a succint description of the change:
#
# * use the imperative, present tense: "change" not "changed" nor
# "changes"
# * don't capitalize the first letter
# * no ending punctuation
#
# Commit Message Body
# ---------------------
#
# Just as in the summary, use imperative, present tense: "fix" not "fixed"
# nor "fixes".
#
# Explain the motivation for the change in the commit message body. This
# commit message should explain WHY you are making the change. You can
# include a comparison of the previous behavior with the new behavior in
# order to illustrate the impact of the change.
#
# Commit Message Footer
# ---------------------
#
# The footer can contain information about breaking changes and deprecations
# and is also the place to reference GitHub issues, Azure DevOps workitems,
# Jira tickets, and other PRs that this commit closes or is related to.
#
# The main structure could be:
#
# ```
# BREAKING CHANGE: <breaking change summary>
# <BLANK LINE>
# <breaking change description + migration instructions>
# <BLANK LINE>
# <BLANK LINE>
# Fixes #<issue number>
# ```
#
# or
#
# ```
# DEPRECATED: <what is deprecated>
# <BLANK LINE>
# <deprecation description + recommended update path>
# <BLANK LINE>
# <BLANK LINE>
# Closes #<pr number>
# ```
#
# Breaking Change section should start with the phrase "BREAKING CHANGE: "
# followed by a summary of the breaking change, a blank line, and a
# detailed description of the breaking change that also includes migration
# instructions.
#
# Similarly, a Deprecation section should start with "DEPRECATED: "
# followed by a short description of what is deprecated, a blank line,
# and a detailed description of the deprecation that also mentions the
# recommended update path.
#
# Revert commits
# ---------------------
#
# If the commit reverts a previous commit, it should begin with
# `revert: `, followed by the header of the reverted commit.
#
# The content of the commit message body should contain:
#
# * information about the SHA of the commit being reverted in the format:
# `This reverts commit <SHA>`,
# * a clear description of the reason for reverting the commit message.
#
# See https://www.conventionalcommits.org/
# See also https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit