From 7a838cb9956ec8def96cf57dd826aeefc61b1418 Mon Sep 17 00:00:00 2001 From: Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com> Date: Wed, 14 Dec 2016 19:14:54 -0500 Subject: [PATCH] docs: added code snippet showing how to install commitizen. --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 84f71df3..5c9e1307 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,15 @@ highly recommended developers install [Commitizen](https://commitizen.github.io/ it extends the git command and will make writing commit messages a breeze. All the Aparapi repositories are configured with local Commitizen configuration scripts. +Getting Commitizen installed is usually trivial, just install it via npm. You will also +need to install the cz-customizable adapter which the Aparapi repository is configured +to use. + +```bash + +npm i -g commitizen cz-customizable +``` + Below is an example of Commitizen in action. It replaces your usual `git commit` command with `git cz` instead. The new command takes all the same arguments however it leads you through an interactive process to generate the commit message. -- GitLab