From 34bc9d526ae05a302680b2d430e9fdde70ca651e Mon Sep 17 00:00:00 2001 From: NataliaLKB Date: Thu, 2 Apr 2015 09:36:02 +0100 Subject: [PATCH] Making the commit message guidelines into bullet points for quick reading --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6e118e8..bf5f465 100644 --- a/README.md +++ b/README.md @@ -374,12 +374,14 @@ Likewise, even in pull requests, you must aim to make your commits a clear and c ## Commit messages Just like choosing when to commit, and what to commit, it is also important to think about your naming. It is always good to be as descriptive as possible with your commit messages. + Also consider: -Present tense for your commit messages -If related to an issue on github, should contain issue number -The first line should be 50 characters or less. Your message should be brief and to the point. -Focus on why you did something, not how you did it -Avoid `ands` . If you find yourself wanting to write `and`, you should probably break up that commit into multiple ones. +* Present tense for your commit messages +* If related to an issue on github, should contain issue number +* The first line should be 50 characters or less. Your message should be brief and to the point. +* Focus on why you did something, not how you did it +* Avoid `ands`. If you find yourself wanting to write `and`, you should probably break up that commit into multiple ones. + Remember that the purpose of this commit is to be a message for future you, or your colleagues who may have not known what you are working on. Try to think about your message with this in mind. Many development teams take it one step further and turn their commit messages into change logs. These change logs may be used for user consumption making it all the more important to have clear messages of what was done for that commit.