realmarcos / cz-conventional-emoji

A commitizen adapter following the conventional-changelog format with emoji.

cz-conventional-emoji

A commitizen adapter following the conventional-changelog format with emoji.

English | 简体中文

 Select the type of change that you're committing: (Use arrow keys)
❯ ✨  Feat:              Introducing new features.
  🐛  Bug:               Fixing a bug.
  📝  Docs:              Writing docs.
  🎨  Style:             Improving structure / format of the code.
  💄  UI:                Updating the UI and style files.
  🚑  Quickfix:          Critical hotfix.
  ⚡️  Pref:              Improving performance.
(Move up and down to reveal more choices)

Installation

We think you've already installed the Commitizen.

Globally

yarn global add cz-conventional-emoji
# OR
# npm install --global cz-conventional-emoji

# set as default adapter globally
echo '{ "path": "cz-conventional-emoji" }' > ~/.czrc

Locally

yarn add cz-conventional-emoji
# OR
# npm install --save-dev cz-conventional-emoji

# set as default adapter for your projects
"config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-emoji"
    },
  },

Usage

Simply use git cz instead of git commit when committing. See the doc of Commitizen for more info.

Author

gaoancun [email protected]

License

MIT