From: Junio C Hamano Date: Thu, 4 May 2017 07:26:46 +0000 (+0900) Subject: Merge branch 'rg/doc-submittingpatches-wordfix' X-Git-Tag: v2.13.0-rc2~3 X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=9f3e2fe9f4176b5f0eb14e26b34d21f4dffcebd2;p=git-core%2Fgit.git Merge branch 'rg/doc-submittingpatches-wordfix' * rg/doc-submittingpatches-wordfix: doc: update SubmittingPatches --- 9f3e2fe9f4176b5f0eb14e26b34d21f4dffcebd2 diff --cc Documentation/SubmittingPatches index bc8ad0047,75c886aa1..558d465b6 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@@ -104,17 -104,12 +104,17 @@@ identifier for the general area of the If in doubt which identifier to use, run "git log --no-merges" on the files you are modifying to see the current conventions. +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 body should provide a meaningful commit message, which: - . explains the problem the change tries to solve, iow, what is wrong + . explains the problem the change tries to solve, i.e. what is wrong with the current code without the change. - . justifies the way the change solves the problem, iow, why the + . justifies the way the change solves the problem, i.e. why the result with the change is better. . alternate solutions considered but discarded, if any.