Skip to content

Commit 2ee0056

Browse files
avargitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 7c9c2f8 commit 2ee0056

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

Documentation/SubmittingPatches

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,17 @@ should skip the full stop. It is also conventional in most cases to
9898
prefix the first line with "area: " where the area is a filename or
9999
identifier for the general area of the code being modified, e.g.
100100

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
103103

104104
If in doubt which identifier to use, run "git log --no-merges" on the
105105
files you are modifying to see the current conventions.
106106

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+
107112
The body should provide a meaningful commit message, which:
108113

109114
. explains the problem the change tries to solve, iow, what is wrong

0 commit comments

Comments
 (0)