A demo repository that exemplifies all techniques discussed in the Git commit messages for the bold and the daring article.
This repository contains four tagged versions, each corresponding to a different technique discussed in the article:
commit-templatehuskycommitizen-with-conventional-changelogcommitizen-with-commitlint
To try out one specific technique just checkout the corresponding tag and you're good to go.
Clone the repository:
git clone https://github.com/CarmenPopoviciu/commit-guidelines.git
Change your current working directory to the repository directory:
cd commit-guidelines
Install npm dependencies:
npm install
or
yarn
Checkout the version you're interested in and start playing around (please see below the necessary setup instructions for each available tag)
Checkout the commit-template tag:
git checkout commit-template
Change your local Git configuration to use the example template in the repository (see the .git-message-template file):
git config --local commit.template "path_to/.git-message-template"
Make some changes in the repository and commit them:
git commit
Rejoice \o/
Checkout the husky tag:
git checkout husky
Make some changes in the repository and commit them:
git commit
Rejoice some more \o/
Checkout the commitizen-with-conventional-changelog tag:
git checkout commitizen-with-conventional-changelog
Make some changes in the repository and commit them:
npm run commit
or
yarn commit
Happiness FTW
Checkout the commitizen-with-commitlint tag:
git checkout commitizen-with-commitlint
Make some changes in the repository and commit them:
npm run commit
or
yarn commit
Have an ice cream, you deserved it!
