Cz-conventional-commit NPM

cz-conventional-commit

Status:

Part of the commitizen family. Prompts for conventional changelog standard.

How to use

Adaptater for commitizen

To use this package, you need to add this following to your package.json root file :

"config": {
    "commitizen": {
      "path": "cz-conventional-commit"
    },
}

What's change ?

Four types of commit are now available (with emojis ):

fix
feat
style
refactor

Commitizen Interface

There are now just three steps : type, scope and short description. Example of a commit ruled by this package :

Commitizen Steps

Configuration

package.json

Like commitizen, you specify the configuration of cz-conventional-changelog through the package.json's config.commitizen key.

{
// ...  default values
    "config": {
        "commitizen": {      
            "path": "cz-conventional-commit",
            "maxHeaderWidth": 100,
            "maxLineWidth": 100,
            "defaultType": "",
            "defaultScope": "",        
            "defaultSubject": ""
        }
    }
// ...    
}