]> git.ipfire.org Git - thirdparty/git.git/commit
doc: clarify "do not capitalize the first word" rule
authorJunio C Hamano <gitster@pobox.com>
Wed, 14 Apr 2021 23:51:17 +0000 (16:51 -0700)
committerJunio C Hamano <gitster@pobox.com>
Thu, 15 Apr 2021 06:41:00 +0000 (23:41 -0700)
commit151b6c2dd7d040bd053911e4fd4b3e5cc6f17c83
tree6b9789d4a44d787e91973dbf426d982e2be2201a
parent48bf2fa8bad054d66bd79c6ba903c89c704201f7
doc: clarify "do not capitalize the first word" rule

The same "do not capitalize the first word" rule is applied to both
our patch titles and error messages, but the existing description
was fuzzy in two aspects.

 * For error messages, it was not said that this was only about the
   first word that begins the sentence.

 * For both, it was not clear when a capital letter there was not an
   error.  We avoid capitalizing the first word when the only reason
   you would capitalize it is because it happens to be the first
   word in the sentence.  If a proper noun, which is usually spelled
   in capital letters, happens to come at the beginning of the
   sentence, it should be kept in capital letters.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/CodingGuidelines
Documentation/SubmittingPatches