summaryrefslogtreecommitdiffstats
path: root/Documentation/SubmittingPatches
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2022-10-07 20:07:54 +0200
committerJunio C Hamano <gitster@pobox.com>2022-10-07 23:59:25 +0200
commit3991bb73dd01332459c84a72365daa17065c62ea (patch)
tree22efd562adeebed77f00d74b0872e07f1d725857 /Documentation/SubmittingPatches
parentMerge a handful of topics from the 'master' front (diff)
downloadgit-3991bb73dd01332459c84a72365daa17065c62ea.tar.xz
git-3991bb73dd01332459c84a72365daa17065c62ea.zip
SubmittingPatches: use usual capitalization in the log message body
Update the description of the summary section to clarify that the "do not capitalize" rule applies only the word after the "<area>:" prefix of the title and nowhere else. This hopefully will prevent folks from writing their proposed log message in all lowercase. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to '')
-rw-r--r--Documentation/SubmittingPatches4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 5bd795e5db..927f7329a5 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -153,7 +153,9 @@ files you are modifying to see the current conventions.
[[summary-section]]
The title sentence after the "area:" prefix omits the full stop at the
-end, and its first word is not capitalized unless there is a reason to
+end, and its first word is not capitalized (the omission
+of capitalization applies only to the word after the "area:"
+prefix of the title) unless there is a reason to
capitalize it other than because it is the first word in the sentence.
E.g. "doc: clarify...", not "doc: Clarify...", or "githooks.txt:
improve...", not "githooks.txt: Improve...". But "refs: HEAD is also