cz-ekthos

Ekthos' Commitizen

Default commitizen used for Ekthos' software projects.

The commit types follow the table described in the Contribution Guide.

Installation and Usage

NodeJS

It's very simple to install this in your NodeJS project. All you have to do is run the following commands:

npm install --global commitizen
npm install --save-dev cz-ekthos
npx cz-ekthos

This command will install this package and implement the commitizen in your project by making a few changes in your package.json file.

Now, in order to use this commitizen, you'll stop using the default git commit command to commit your messages, and use this instead:

git cz
# or
npm run commit
# don't use "git commit"

This will open an interactive prompt with 3 steps:

• Firstly, pick which category best suits your commit
• Then, write a short message in the imperative mood, describing the changes made
• Finally, confirm if you want to proceed with the generated commit