mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 09:53:47 +01:00
Code Issues Projects Releases Wiki Activity

Use the imperative mood in example subject line

Browse Source 
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.
This commit is contained in:
Tobin Harding 2021-12-10 11:49:20 +11:00
parent 2f26d8ec70
commit efde111615
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

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