You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/guide-contributor/workflow.md
+34-22Lines changed: 34 additions & 22 deletions
Original file line number
Diff line number
Diff line change
@@ -141,46 +141,55 @@ visualizes this process.
141
141
142
142
### Commit messages
143
143
144
-
Generally, no specific formatting of individual commit messages is required when working
145
-
on feature branches. However, your pull request titles should always follow the
146
-
[Conventional Commits specification][conv-commits]. The same is true for
144
+
Generally, no specific formatting of individual commit messages is required when
145
+
working on _feature branches_. However, your **pull request titles MUST follow
146
+
the [Conventional Commits specification][conv-commits]**. The same is true for
147
147
individual commit messages if you are requesting that your feature branch be
148
148
"rebase merged" (see info box "Substantial changes" above).
149
149
150
-
[Conventional Commits][conv-commits] help to increase consistency, simplify
151
-
maintenance and enable automated versioning and change log generation. Their
150
+
[Conventional Commits][conv-commits] help to increase consistency, facilitate
151
+
maintenance and enable automated versioning and change log generation. Their
152
152
general structure is as follows:
153
153
154
154
```console
155
-
<type>(optional scope): <description> # not more than 50 characters!!!
155
+
<type>(optional scope): <description>
156
156
157
157
[optional body]
158
158
159
159
[optional footer]
160
160
```
161
161
162
-
Please keep the _title_ line short (50 characters or less). If you want to get
163
-
more descriptive, you can use the optional _body_. Please use the _footer_
164
-
only to signify breaking changes, by adding `BREAKING CHANGE` to the start of
165
-
the footer and describing why/what breaks. You can use multiple lines for
166
-
body and footer, but please keep each line to 100 characters or less. For
167
-
smaller projects such as most of ours, use of _scope_ is not recommended.
162
+
Please follow these rules for your commit messages / PR titles:
163
+
164
+
- Keep your entire header/title line (including type and, if available, scope)
165
+
at **50 characters or less**
166
+
- Only use the types listed in the table below; choose the type according to the
167
+
predominant reason for the change
168
+
- Never use types `feat`, `fix`, `perf`, `refactor` and `style` only for changes
169
+
in packaged/production code; use the dedicated types for all build-, CI-,
170
+
documentation- or test-related changess
171
+
- Indicating a scope is optional; it is only necessary if scopes are generally
172
+
used in the repository you are working on
173
+
- Start the `<description>` with a verb in imperative form (e.g., `add`, `fix`)
174
+
- If you include a body and/or footer, make sure it conforms to the
175
+
Conventional Commits specification
168
176
169
177
Depending on the changes, we would kindly request you to use one of the
170
178
following **type** prefixes:
171
179
172
180
| Type | Description |
173
181
| --- | --- |
174
-
| build | The build type (formerly known as chore) is used to identify development changes related to the build system (involving scripts, configurations or tools) and package dependencies. |
175
-
| ci | The ci type is used to identify development changes related to the continuous integration and deployment system - involving scripts, configurations or tools. |
176
-
| docs | The docs type is used to identify documentation changes related to the project - whether intended externally for the end users (in case of a library) or internally for the developers. |
177
-
| feat | The feat type is used to identify production changes related to new backward-compatible abilities or functionality. |
178
-
| fix | The fix type is used to identify production changes related to backward-compatible bug fixes. |
179
-
| perf | The perf type is used to identify production changes related to backward-compatible performance improvements. |
180
-
| refactor | The refactor type is used to identify development changes related to modifying the codebase, which neither adds a feature nor fixes a bug - such as removing redundant code, simplifying the code, renaming variables, etc. |
181
-
| revert | For commits that revert one or more previous commits. |
182
-
| style | The style type is used to identify development changes related to styling the codebase, regardless of the meaning - such as indentations, semi-colons, quotes, trailing commas and so on. |
183
-
| test | The test type is used to identify development changes related to tests - such as refactoring existing tests or adding new tests. |
182
+
| build | For changes related to the build system (e.g., scripts, configurations and tools) and package dependencies |
183
+
| chore | For changes related to mundane repository maintenance tasks that are not covered by any of the other types (e.g., adding a `.gitignore file) |
184
+
| ci | For changes related to the continuous integration and deployment system (e.g., workflows, scripts, configurations and tools) |
185
+
| docs | For changes related to the project documentation, regardless of the audience (end users, developers) |
186
+
| feat | For changes related to new abilities or functionality |
187
+
| fix | For changes related to bug fixes |
188
+
| perf | For changes related to performance improvements |
189
+
| refactor | For changes related to modifying the codebase, which neither adds a feature nor fixes a bug (e.g., removing redundant code, simplifying code, renaming variables) |
190
+
| revert | For changes that revert one or more previous commits |
191
+
| style | For changes related to styling the codebase (e.g., indentation, parentheses/brackets, white space, trailing commas) |
192
+
| test | For changes related to tests |
184
193
185
194
!!! info "Linting commit messages"
186
195
@@ -191,6 +200,9 @@ following **type** prefixes:
191
200
192
201
### Filing pull requests
193
202
203
+
**Make sure to follow the [commit message](#commit-messages) rules for your pull
204
+
request titles.**
205
+
194
206
The following pull request template will be successively added to all
195
207
repositories. Until that is the case, you can already make use of it by
196
208
self-reviewing your pull requests according to the checklist and descriptions.
0 commit comments