From 164b3e2ba8289759a6c4c6b6c4a245e69ee98a83 Mon Sep 17 00:00:00 2001 From: Alex Ellis Date: Tue, 3 Apr 2018 22:22:36 +0100 Subject: [PATCH] Update guidance on commit messages Mentions not terminating lines with punctuation Signed-off-by: Alex Ellis (VMware) --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47e1ab13..c538e7d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,11 +62,12 @@ Please read this whole guide and make sure you agree to our DCO agreement (inclu The first line of the commit message is the *subject*, this should be followed by a blank line and then a message describing the intent and purpose of the commit. These guidelines are based upon a [post by Chris Beams](https://chris.beams.io/posts/git-commit/). * When you run `git commit` make sure you sign-off the commit by typing `git commit -s`. -* The commit subject should start with an uppercase letter -* The commit subject should not exceed 72 characters in length +* The commit subject-line should start with an uppercase letter +* The commit subject-line should not exceed 72 characters in length +* The commit subject-line should not end with punctuation (., etc) When giving a commit body: -* Leave a blank line after the subject +* Leave a blank line after the subject-line * Make sure all lines are wrapped to 72 characters Here's an example: