Skip to content

Commit 044cf2a

Browse files
author
Juan Gabriel Guzman
committed
build: #201 Adding some other available commit messages keys
1 parent 38be420 commit 044cf2a

File tree

2 files changed

+18
-9
lines changed

2 files changed

+18
-9
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,24 @@ Install the following extensions:
5252
- `Prettier - Code formatter`.
5353
- Go to user settings (`settings.json`) and enable formatting on save: `"editor.formatOnSave": true`.
5454

55-
### Commit message format
56-
A commit message needs to start with one of the following words to bump the application version
57-
properly (This application is following a semver strategy for versioning https://semver.org/)
58-
### Sumary
59-
- **fix** is equal to Patch Release example: 1.0.1
60-
- **feat** is equal to Feature Release example: 1.1.0
61-
- **perf** is equal to Breaking Release example: 2.0.0
55+
### Commit messages format
56+
Commit messages' format follows the [Conventional Commits guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification,
57+
and specifically we are relying on the [Angular commit specifications](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) to bump the [semantic version](https://semver.org/) and generate app change log.
58+
59+
Below there are some common examples you can use for your commit messages:
60+
61+
- **feat**: A new feature.
62+
- **fix**: A bug fix.
63+
- **perf**: A code change that improves performance.
64+
- **build**: Changes that affect the build system or external dependencies (example scopes: npm, ts configuration).
65+
- **ci**: Changes to our CI or CD configuration files and scripts (example scopes: Azure devops, github actions).
66+
- **docs**: Documentation only changes.
67+
- **refactor**: A code change that neither fixes a bug nor adds a feature.
68+
- **style**: Changes that do not affect the meaning of the code (typos, white-space, formatting, missing semi-colons, etc).
69+
It is important to mention that this key is not related to css styles.
70+
- **test**: Adding missing tests or correcting existing tests.
6271
### Example
63-
fix: #48 implement semantic version.
72+
fix: #48 implement semantic versioning.
6473

6574
## Code scaffolding
6675
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
},
7676
"config": {
7777
"commit-message-validator": {
78-
"pattern": "^(fix: #|feat: #|perf: #|style: #)[0-9].*",
78+
"pattern": "^(fix: #|feat: #|perf: #|build: #|ci: #|docs: #|refactor: #|style: #|test: #)[0-9].*",
7979
"errorMessage": "Your commit message needs to start with fix:, feat:, or perf: followed by issue number, e.g. fix: #43 any commit message"
8080
}
8181
},

0 commit comments

Comments
 (0)