2.16.0 • Published 2 years ago
@batatinha-delivery/cz-conventional-changelog v2.16.0
@batatinha-delivery/cz-conventional-changelog
This package provides an iFood adaptation to cz-conventional-changelog
with the following extra features:
- Adds JIRA issue prompt to fill the Jira issue
- Automatically detects the Jira issue from the branch name
Getting started
Install
commitizen
and@batatinha-delivery/cz-conventional-changelog
:npm install commitizen @batatinha-delivery/cz-conventional-changelog -D
Add configuration to .czrc or create a config.commitizen in the package.json
.czrc (as commitizen uses cosmiconfig, several other config files are valid too):
{ "path": "@batatinha-delivery/cz-conventional-changelog" }
package.json:
{ "config": { "commitizen": { "path": "@batatinha-delivery/cz-conventional-changelog" } } }
Commit message
Commit message will be generated in following format:
type(scope): [JIRA_ISSUE] Short description
Example
feat(conventional-changelog): [IFOOD-1234] Implement conventional changelog