Skip to content
This repository was archived by the owner on Jan 30, 2019. It is now read-only.

Commit e2b6dae

Browse files
clydinhansl
authored andcommitted
docs: update commit message scope guidelines (angular#5121)
1 parent dd9eb17 commit e2b6dae

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

CONTRIBUTING.md

+19-6
Original file line numberDiff line numberDiff line change
@@ -171,19 +171,32 @@ If the commit reverts a previous commit, it should begin with `revert: `, follow
171171
### Type
172172
Must be one of the following:
173173

174+
* **build**: Changes that affect the build system or external dependencies
175+
* **ci**: Changes to our CI configuration files and scripts
176+
* **docs**: Documentation only changes
174177
* **feat**: A new feature
175178
* **fix**: A bug fix
176-
* **docs**: Documentation only changes
179+
* **perf**: A code change that improves performance
180+
* **refactor**: A code change that neither fixes a bug nor adds a feature
177181
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
178182
semi-colons, etc)
179-
* **refactor**: A code change that neither fixes a bug nor adds a feature
180-
* **perf**: A code change that improves performance
181183
* **test**: Adding missing tests or correcting existing tests
182-
* **build** Changes that affect the build system, CI configuration or external dependencies (example scopes: gulp, broccoli, npm)
183184

184185
### Scope
185-
The scope could be anything specifying place of the commit change. For example
186-
`Compiler`, `ElementInjector`, etc.
186+
The scope should be the name of the npm package affected as perceived by the person reading changelog generated from the commit messages.
187+
188+
The following is the list of supported scopes:
189+
190+
* **@angular/cli**
191+
* **@ngtools/json-schema**
192+
* **@ngtools/logger**
193+
* **@ngtools/webpack**
194+
195+
There are currently a few exceptions to the "use package name" rule:
196+
197+
* **packaging**: used for changes that change the npm package layout in all of our packages, e.g. public path changes, package.json changes done to all packages, d.ts file/format changes, changes to bundles, etc.
198+
* **changelog**: used for updating the release notes in CHANGELOG.md
199+
* none/empty string: useful for `style`, `test` and `refactor` changes that are done across all packages (e.g. `style: add missing semicolons`)
187200

188201
### Subject
189202
The subject contains succinct description of the change:

0 commit comments

Comments
 (0)