From a64b70db4a36f11dbd22b4bc6a35f616061e0241 Mon Sep 17 00:00:00 2001 From: probonopd Date: Sat, 4 Nov 2017 14:36:01 +0100 Subject: Format commit message as code block --- README.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 95ac4a2fd..45423c4ef 100644 --- a/README.md +++ b/README.md @@ -113,24 +113,26 @@ See: http://developercertificate.org/ Also, please write good git commit messages. A good commit message looks like this: - Header line: explain the commit in one line (use the imperative) - - 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 paragraphs, 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. - - Make sure you explain your solution and why you're doing what you're - doing, as opposed to describing what you're doing. Reviewers and your - future self can read the patch, but might not understand why a - particular solution was implemented. - - Reported-by: whoever-reported-it - Signed-off-by: Your Name +``` +Header line: explain the commit in one line (use the imperative) + +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 paragraphs, 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. + +Make sure you explain your solution and why you're doing what you're +doing, as opposed to describing what you're doing. Reviewers and your +future self can read the patch, but might not understand why a +particular solution was implemented. + +Reported-by: whoever-reported-it +Signed-off-by: Your Name +``` 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 -- cgit v1.2.3-70-g09d2