Skip to content

Commit afaf2bc

Browse files
committed
Fix quote from Tim Pope's blog.
1 parent 6956b0c commit afaf2bc

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

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

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -66,23 +66,27 @@ Here is a https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[
6666

6767
[source,text]
6868
----
69-
Short (50 chars or less) summary of changes
69+
Capitalized, short (50 chars or less) summary
7070
71-
More detailed explanatory text, if necessary. Wrap it to
72-
about 72 characters or so. In some contexts, the first
73-
line is treated as the subject of an email and the rest of
74-
the text as the body. The blank line separating the
75-
summary from the body is critical (unless you omit the body
76-
entirely); tools like rebase can get confused if you run
77-
the two together.
71+
More detailed explanatory text, if necessary. Wrap it to about 72
72+
characters or so. In some contexts, the first line is treated as the
73+
subject of an email and the rest of the text as the body. The blank
74+
line separating the summary from the body is critical (unless you omit
75+
the body entirely); tools like rebase can get confused if you run the
76+
two together.
77+
78+
Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
79+
or "Fixes bug." This convention matches up with commit messages generated
80+
by commands like git merge and git revert.
7881
7982
Further paragraphs come after blank lines.
8083
81-
- Bullet points are okay, too
84+
- Bullet points are okay, too
85+
86+
- Typically a hyphen or asterisk is used for the bullet, followed by a
87+
single space, with blank lines in between, but conventions vary here
8288
83-
- Typically a hyphen or asterisk is used for the bullet,
84-
preceded by a single space, with blank lines in
85-
between, but conventions vary here
89+
- Use a hanging indent
8690
----
8791

8892
If all your commit messages follow this model, things will be much easier for you and the developers with whom you collaborate.

0 commit comments

Comments
 (0)