Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
build: #201 Adding some other available commit messages keys
  • Loading branch information
Juan Gabriel Guzman committed May 5, 2020
commit 044cf2a2315abbf4a8eaf67b289526f93784c430
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,15 +52,24 @@ Install the following extensions:
- `Prettier - Code formatter`.
- Go to user settings (`settings.json`) and enable formatting on save: `"editor.formatOnSave": true`.

### Commit message format
A commit message needs to start with one of the following words to bump the application version
properly (This application is following a semver strategy for versioning https://semver.org/)
### Sumary
- **fix** is equal to Patch Release example: 1.0.1
- **feat** is equal to Feature Release example: 1.1.0
- **perf** is equal to Breaking Release example: 2.0.0
### Commit messages format
Commit messages' format follows the [Conventional Commits guidelines](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification,
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.

Below there are some common examples you can use for your commit messages:

- **feat**: A new feature.
- **fix**: A bug fix.
- **perf**: A code change that improves performance.
- **build**: Changes that affect the build system or external dependencies (example scopes: npm, ts configuration).
- **ci**: Changes to our CI or CD configuration files and scripts (example scopes: Azure devops, github actions).
- **docs**: Documentation only changes.
- **refactor**: A code change that neither fixes a bug nor adds a feature.
- **style**: Changes that do not affect the meaning of the code (typos, white-space, formatting, missing semi-colons, etc).
It is important to mention that this key is not related to css styles.
- **test**: Adding missing tests or correcting existing tests.
### Example
fix: #48 implement semantic version.
fix: #48 implement semantic versioning.

## Code scaffolding
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`.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
},
"config": {
"commit-message-validator": {
"pattern": "^(fix: #|feat: #|perf: #|style: #)[0-9].*",
"pattern": "^(fix: #|feat: #|perf: #|build: #|ci: #|docs: #|refactor: #|style: #|test: #)[0-9].*",
"errorMessage": "Your commit message needs to start with fix:, feat:, or perf: followed by issue number, e.g. fix: #43 any commit message"
}
},
Expand Down