Skip to content

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

License

Notifications You must be signed in to change notification settings

SuPuL/cz-conventional-emoji

 
 

Repository files navigation

@supul/cz-conventional-emoji

A commitizen adapter following the conventional-changelog format with emoji after type and scope.

Commitizen friendly

NPM

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 @supul/cz-conventional-emoji
# OR
# npm install --global @supul/cz-conventional-emoji

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

Locally

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

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

Usage

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

Author

Origin: gaoancun gaoac.snow@outlook.com

Fork by: supul

License

MIT

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%