undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'jc/doc-do-not-capitalize-clarification'

Browse Source 
Doc update for developers.

* jc/doc-do-not-capitalize-clarification:
  doc: clarify "do not capitalize the first word" rule
This commit is contained in:
Junio C Hamano 2021-04-20 17:23:36 -07:00
commit 092bf77e8c
2 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/CodingGuidelines
View File

@ -498,7 +498,12 @@ Error Messages
- Do not end error messages with a full stop. - Do not end error messages with a full stop.
- Do not capitalize ("unable to open %s", not "Unable to open %s") - Do not capitalize the first word, only because it is the first word
in the message ("unable to open %s", not "Unable to open %s"). But
"SHA-3 not supported" is fine, because the reason the first word is
capitalized is not because it is at the beginning of the sentence,
but because the word would be spelled in capital letters even when
it appeared in the middle of the sentence.
- Say what the error is first ("cannot open %s", not "%s: cannot open") - Say what the error is first ("cannot open %s", not "%s: cannot open")

11
Documentation/SubmittingPatches
View File

@ -117,10 +117,13 @@ If in doubt which identifier to use, run `git log --no-merges` on the
files you are modifying to see the current conventions. files you are modifying to see the current conventions.
[[summary-section]] [[summary-section]]
It's customary to start the remainder of the first line after "area: " The title sentence after the "area:" prefix omits the full stop at the
with a lower-case letter. E.g. "doc: clarify...", not "doc: end, and its first word is not capitalized unless there is a reason to
Clarify...", or "githooks.txt: improve...", not "githooks.txt: capitalize it other than because it is the first word in the sentence.
Improve...". E.g. "doc: clarify...", not "doc: Clarify...", or "githooks.txt:
improve...", not "githooks.txt: Improve...". But "refs: HEAD is also
treated as a ref" is correct, as we spell `HEAD` in all caps even when
it appears in the middle of a sentence.
[[meaningful-message]] [[meaningful-message]]
The body should provide a meaningful commit message, which: The body should provide a meaningful commit message, which: