From 1f5f70ef5a09933fb88dbfca9cfb8915109e6eff Mon Sep 17 00:00:00 2001 From: Steve Schnepp Date: Tue, 20 Jan 2015 22:04:39 +0100 Subject: [PATCH] README: Add some precision to the commit message --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 182ae929..26343f3f 100644 --- a/README.md +++ b/README.md @@ -36,12 +36,15 @@ This serves as a repository for examples of various configs. You know, the ''lea ### Commits, Comments & Pull requests -We like to have ''elementary'' commits as it is much easier to manage for reviewing and debugging. +We like to have _elementary_ commits as it is much easier to manage for reviewing and debugging. So please **don't** be afraid to make **as many** commits as needed. Merging many commits is as easy as merging one, if not easier. A good rationale is that each commit shall have a one-liner commit comment as its first line. -Next lines are optional and should only explain the ''why'' it is done this particular way. +Ideally that first line has a prefix that shows the part the commit is about. It makes it very +easy to see grouped changes, and it enable avoiding to look at the --stat. To know the prefix you should +use, you can have a look at already existing commits. Next lines are optional and should only +explain the _why_ it is done this particular way. On the other side, pull requests can regroup many commits at once. Just try to explain in the pull comment the ''why'' we should merge it (if it's not obvious).