doc/SubmittingPatches: clarify the casing convention for "area: change..."
Amend the section which describes how the first line of the subject should look like to say that the ":" in "area: " shouldn't be treated like a full stop for the purposes of letter casing. Change the two subject examples to make this new paragraph clearer, i.e. "unstar" is not a common word, and "git-cherry-pick.txt" is a much longer string than "githooks.txt". Pick two recent commits from git.git that fit better for the description. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ævar Arnfjörð Bjarmason committed
Mar 21, 2017 at 14:21 UTC
2ee0056779a7fb736092fc78de10b7e908f46f25
1 file changed
+7
-2
Documentation/SubmittingPatches
+7
-2
@@ -98,12 +98,17 @@ should skip the full stop. It is also conventional in most cases to
98
prefix the first line with "area: " where the area is a filename or
99
identifier for the general area of the code being modified, e.g.
100
101
- . archive: ustar header checksum is computed unsigned
102
- . git-cherry-pick.txt: clarify the use of revision range notation
101
+ . doc: clarify distinction between sign-off and pgp-signing
102
+ . githooks.txt: improve the intro section
103
104
If in doubt which identifier to use, run "git log --no-merges" on the
105
files you are modifying to see the current conventions.
106
107
+It's customary to start the remainder of the first line after "area: "
108
+with a lower-case letter. E.g. "doc: clarify...", not "doc:
109
+Clarify...", or "githooks.txt: improve...", not "githooks.txt:
110
+Improve...".
111
+
112
The body should provide a meaningful commit message, which:
113
114
. explains the problem the change tries to solve, iow, what is wrong