From dc842ffa09e75e06b8b5dd35002d16b7de81fce5 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Wed, 12 Aug 2015 20:38:43 +0200 Subject: [PATCH] Add a word about git commits --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e0f882cd..f006cfe6a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -109,6 +109,22 @@ in the project root directory before committing. Installing the script pre-commit hook checks formatting before committing automatically, just copy this script to `.git/hooks/pre-commit`. +Git Commits +----------- + +I would be good if you could follow the same general style regarding Git +commits as the rest of the project, this makes reviewing code, browsing the +history and triaging bugs much easier. + +Git commit messages have a very terse summary in the first line of the commit +message, followed by an empty line, followed by a more verbose description or a +List of changed things. For examples, please refer to the excellent [How to +Write a Git Commit Message](http://chris.beams.io/posts/git-commit/). + +If you change/add multiple different things that aren't related at all, try to +make several smaller commits. This is much easier to review. Using `git add -p` +allows staging and committing only some changes. + Code Review ===========