X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=README;h=a9eb649ee052697bc0c554b66df1e18a873450d9;hb=7bbdea19ed0c634b4a990e49be7a2c8936a61818;hp=19ddae26a27fa62ea642c0e445192c5385126e26;hpb=454a45617230274c3fff57ad2f70fb35d7f7142b;p=ext%2Fsubsurface.git

diff --git a/README b/README
index 19ddae2..a9eb649 100644
--- a/README
+++ b/README
@@ -49,3 +49,24 @@ the right to pass it on as an open source patch.
 
 See: http://gerrit.googlecode.com/svn/documentation/2.0/user-signedoffby.html
 
+Also, please write good git commit messages.  A good commit message
+looks like this:
+
+	header line: explaining the commit in one line
+
+	Body of commit message is a few lines of text, explaining things
+	in more detail, possibly giving some background about the issue
+	being fixed, etc etc.
+
+	The body of the commit message can be several paragrahps, and
+	please do proper word-wrap and keep columns shorter than about
+	74 characters or so. That way "git log" will show things
+	nicely even when it's indented.
+
+	Reported-by: whoever-reported-it
+	Signed-off-by: Your Name <youremail@yourhost.com>
+
+where that header line really should be meaningful, and really should be
+just one line.  That header line is what is shown by tools like gitk and
+shortlog, and should summarize the change in one readable line of text,
+independently of the longer explanation.