cz-customizable

cz-customizable

This is a customizable Commitizen plugin. You can specify the commit types, scopes and override scopes for specific types.

Steps:

• install commitizen in case you don't have it: npm install -g commitizen

• install the cz-customizable: npm install cz-customizable --save-dev

• configure commitizen to use cz-customizable as plugin. Add those lines to your package.json:

  ...
  "config": {
    "commitizen": {
      "path": "node_modules/cz-customizable"
    }
  }
  

• you should commit your .cz-config.js file to your git. Run cp ./node_modules/cz-customizable/cz-config-EXAMPLE.js ./.cz-config.js in a project root directory to get a template.

• if you don't provide a config file, this adapter will use the contents of the default file node_modules/cz-customizable/cz-config-EXAMPLE.js

From now on, instead of git commit you type git cz and let the tool do the work for you.

Hopefully this will help you to have consistent commit messages and have a fully automated deployemnt without any human intervention.

Related tools:

• (https://github.com/commitizen/cz-cli)
• (https://github.com/stevemao/conventional-recommended-bump)
• (https://github.com/semantic-release/semantic-release)

It prompts for conventional changelog standard.

GOTCHAS

• backticks If you wish to have backticks in your content, for example "feat: `string`", the commit preview will be "feat: \\string\\\\". Don't worry because on your git log will be "feat: `string`" as desired.

• multiline contents on the body of the message Body is the only place where you can use a pipe to break lines. E.g.: you type this: my items are:| - item01| - item 02, which will become:

my items are: - item01 - item 02

CONTRIBUTING

Please refer to the Contributor Guidelines and Conduct of Code from AngularJs project.

Leonardo Correa