@tophat/commitizen-adapter

@tophat/commitizen-adapter

A commitizen adapter that lets you interactively build commit messages using Top Hat's commit convention.

Installation

First, make sure you have commitizen installed and configured globally

npm install -g commitizen

Then install the Top Hat commitizen adapter:

Using Yarn

yarn add @tophat/commitizen-adapter --dev

or using npm

npm install @tophat/commitizen-adapter --save-dev

Add the following snippet to your package.json file

"config": {
  "commitizen": {
    "path": "./node_modules/@tophat/commitizen-adapter"
  }
}

Alternatively, if you're using a .czrc file, add this

{
  "path": "@tophat/commitizen-adapter"
}

Usage

Running git cz should now bring up an interactive prompt that lets you build commit messages