Skip to content

Commit 65e89e9

Browse files
committed
Clarify commit message style.
1 parent afaf2bc commit 65e89e9

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

book/05-distributed-git/sections/contributing.asc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,7 @@ The last thing to keep in mind is the commit message.
5959
Getting in the habit of creating quality commit messages makes using and collaborating with Git a lot easier.
6060
As a general rule, your messages should start with a single line that's no more than about 50 characters and that describes the changeset concisely, followed by a blank line, followed by a more detailed explanation.
6161
The Git project requires that the more detailed explanation include your motivation for the change and contrast its implementation with previous behavior -- this is a good guideline to follow.
62-
It's also a good idea to use the imperative present tense in these messages.
63-
In other words, use commands.
64-
Instead of ``I added tests for'' or ``Adding tests for,'' use ``Add tests for.''
62+
Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug."
6563
Here is a https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[template originally written by Tim Pope]:
6664

6765
[source,text]

0 commit comments

Comments
 (0)