From 5f00372af2e0aa0ec540830ba575fe83ae16017f Mon Sep 17 00:00:00 2001 From: Johannes 'fish' Ziemke Date: Wed, 30 Apr 2014 19:23:51 +0200 Subject: [PATCH] Add notes about git commit messages This improves readability of commits a lot and is easy to follow. I think most people follow those rules already. They are based on http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html Docker-DCO-1.1-Signed-off-by: Johannes 'fish' Ziemke (github: discordianfish) --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e8b98122f..5a1ad4b0ab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,6 +90,10 @@ reference to all the issues that they address. Pull requests must not contain commits from other users or branches. +Commit messages must start with a capitalized and short summary (max. 50 +chars) written in the imperative, followed by an optional, more detailed +explanatory text which is separated from the summary by an empty line. + Code review comments may be added to your pull request. Discuss, then make the suggested modifications and push additional commits to your feature branch. Be sure to post a comment after pushing. The new commits will show up in the pull