Skip to content

Commit efde111

Browse files
committed
Use the imperative mood in example subject line
The section `Committing Patches` contains an example commit subject line that violates rule seven of the linked guide to writing commit logs (Chris Beams famous blog post). We should practice what we preach, especially in examples :) Use the imperative mood in example commit message subject line.
1 parent 2f26d8e commit efde111

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ own without warnings, errors, regressions, or test failures.
119119

120120
Commit messages should be verbose by default consisting of a short subject line
121121
(50 chars max), a blank line and detailed explanatory text as separate
122-
paragraph(s), unless the title alone is self-explanatory (like "Corrected typo
122+
paragraph(s), unless the title alone is self-explanatory (like "Correct typo
123123
in init.cpp") in which case a single title line is sufficient. Commit messages should be
124124
helpful to people reading your code in the future, so explain the reasoning for
125125
your decisions. Further explanation [here](https://chris.beams.io/posts/git-commit/).

0 commit comments

Comments
 (0)