Skip to content

Commit c49b0e7

Browse files
lekhmanruszarend
authored andcommitted
docs: update commit message guidelines (#23997)
(cherry picked from commit 603b248)
1 parent 3223f13 commit c49b0e7

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -205,25 +205,24 @@ the SHA of the commit being reverted.
205205
### Type
206206
Must be one of the following:
207207

208-
* **feat**: A new feature
209-
* **fix**: A bug fix
210-
* **docs**: Documentation only changes
211-
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
212-
semi-colons, etc)
213-
* **refactor**: A code change that neither fixes a bug nor adds a feature
214-
* **perf**: A code change that improves performance
215-
* **test**: Adding missing tests or correcting existing tests
216-
* **build**: Changes that affect the build system, CI configuration or external dependencies
217-
(example scopes: gulp, broccoli, npm)
218-
* **chore**: Other changes that don't modify `src` or `test` files
208+
* **feat**: Creates a new feature
209+
* **fix**: Fixes a previously discovered failure/bug
210+
* **docs**: Changes which exclusively affects documentation
211+
* **refactor**: Refactor without any change in functionality or API (includes style changes)
212+
* **perf**: Improves performance without any change in functionality or API
213+
* **test**: Improvements or corrections made to the project's test suite
214+
* **build**: Changes to local repository build system and tooling
215+
* **ci**: Changes to CI configuration and CI specific tooling
216+
* **release**: A release point in the repository
219217
220218
### Package
221219
The commit message should specify which package is affected by the change. For example:
222220
`material`, `cdk-experimental`, etc.
223221
224222
### Scope
225-
The scope could be anything specifying place of the commit change. For example
226-
`datepicker`, `dialog`, etc.
223+
The scope specifies place of the commit change. For example
224+
`material/datepicker`, `cdk-experimental/dialog`, etc.
225+
See full list [here][commit-message-scopes].
227226
228227
### Subject
229228
The subject contains succinct description of the change:
@@ -261,6 +260,7 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
261260
[material-group]: https://groups.google.com/forum/#!forum/angular-material2
262261
[coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
263262
[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/preview
263+
[commit-message-scopes]: https://github.com/angular/components/blob/master/.ng-dev/commit-message.ts#L10
264264
[corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html
265265
[dev-doc]: https://github.com/angular/components/blob/master/DEV_ENVIRONMENT.md
266266
[github]: https://github.com/angular/components

0 commit comments

Comments
 (0)