From 2beb92ce43d882689f2b64c69b02cde07405d80c Mon Sep 17 00:00:00 2001 From: Andrew Schwartzmeyer Date: Mon, 14 Mar 2016 12:08:19 -0700 Subject: [PATCH] Add note on writing good commit messages --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c998bb8f1..94dfb0364 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,6 +15,15 @@ Please add `[ci skip]` to commits that should be ignored by the CI systems All pull requests **must** pass both CI systems before they will be approved. +Write *good* commit messages. Follow Tim Pope's [guidelines][]: + +* The first line *must* be a short, capitalized summary +* The second line *must* be blank +* The rest should be a wrapped, detailed explanation of the what and why +* The tone should be imperative + +[guidelines]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html + ## Installation #### Windows