When you commit with Commitizen, you’ll be prompted to fill out any required commit fields at commit time.
Step 1: Install NodeJS and Yarn¶
If you are on Windows then try installing them with scoop.sh. It saves time and makes update easier.
Step 2: Install Commitizen¶
Run this command from your command line terminal.
yarn global add commitizen
Step 3: Initialize the Project¶
In the root of Elegant repository, run
We have already gone through the trouble of making Elegant repository Commitizen friendly.
All you have to do is to stage your changes and then run
It will prompt you for questions. Just answer them. Commitizen will automatically format it to conform to Elegant Git commit guidelines.
If your Git commit fails for some reasons, like due to Git hooks, then you can fix the issue and rerun Commitizen using,
git cz --retry
When you use
--retry, Commitizen does not prompt for answers and reuse the answers that you last submitted.