From fb08eb63c4c36cfafe92b5c54e7aa2389914f4ef Mon Sep 17 00:00:00 2001 From: Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com> Date: Wed, 14 Dec 2016 00:05:02 -0500 Subject: [PATCH] docs: added an additional paragraph to the commit message section. --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea556e4b..41131d72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,11 @@ 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. +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 +them first. + Below is an example of a properly formated commit message. ``` -- GitLab