summaryrefslogtreecommitdiffstats
path: root/SubmittingPatches.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2021-04-30 15:08:10 +0900
committerJunio C Hamano <gitster@pobox.com>2021-04-30 15:08:10 +0900
commit4078a55a6fb467915a2f03f271d1390b97eabc13 (patch)
tree94f9713738bf23d7a7bce9c87937558570412c71 /SubmittingPatches.txt
parent9877648272f630de87aeee2e3a8b7f4ac1ad9c70 (diff)
downloadgit-htmldocs-4078a55a6fb467915a2f03f271d1390b97eabc13.tar.gz
Autogenerated HTML docs for v2.31.1-442-g7e391
Diffstat (limited to 'SubmittingPatches.txt')
-rw-r--r--SubmittingPatches.txt11
1 files changed, 7 insertions, 4 deletions
diff --git a/SubmittingPatches.txt b/SubmittingPatches.txt
index 0452db2e6..55287d72e 100644
--- a/SubmittingPatches.txt
+++ b/SubmittingPatches.txt
@@ -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.
[[summary-section]]
-It's customary to start the remainder of the first line after "area: "
-with a lower-case letter. E.g. "doc: clarify...", not "doc:
-Clarify...", or "githooks.txt: improve...", not "githooks.txt:
-Improve...".
+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
+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
+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]]
The body should provide a meaningful commit message, which: