From 50edf1b8cfc4af93a4a225de14ccf9e3bb782ef6 Mon Sep 17 00:00:00 2001 From: Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com> Date: Wed, 14 Dec 2016 18:04:23 -0500 Subject: [PATCH] docs: added commitizen animation to contribution doc. --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41131d72..65ac229a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,12 @@ 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. +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. + + + Commit messages are used to automatically generate our changelogs, and to ensure commits are searchable in a useful way. So please use the Commitizen tool and adhere to the commit message standard or else we cannot accept Pull Requests without editing -- GitLab