diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2017-03-30 14:07:16 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-03-30 14:07:16 -0700 |
| commit | e7cbfd98e3a960450025b58f6678e17c9c01b007 (patch) | |
| tree | 68bbf33aa2e2a5e1c7b8156776b03df7b53277df | |
| parent | Merge branch 'ab/test-readme-updates' (diff) | |
| parent | doc/SubmittingPatches: show how to get a CLI commit summary (diff) | |
| download | tgif-e7cbfd98e3a960450025b58f6678e17c9c01b007.tar.xz | |
Merge branch 'ab/doc-submitting'
Doc update.
* ab/doc-submitting:
doc/SubmittingPatches: show how to get a CLI commit summary
doc/SubmittingPatches: clarify the casing convention for "area: change..."
| -rw-r--r-- | Documentation/SubmittingPatches | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index 3faf7eb884..bc8ad00473 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -98,12 +98,17 @@ should skip the full stop. It is also conventional in most cases to prefix the first line with "area: " where the area is a filename or identifier for the general area of the code being modified, e.g. - . archive: ustar header checksum is computed unsigned - . git-cherry-pick.txt: clarify the use of revision range notation + . doc: clarify distinction between sign-off and pgp-signing + . githooks.txt: improve the intro section 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 @@ -129,8 +134,9 @@ with the subject enclosed in a pair of double-quotes, like this: noticed that ... The "Copy commit summary" command of gitk can be used to obtain this -format. +format, or this invocation of "git show": + git show -s --date=short --pretty='format:%h ("%s", %ad)' <commit> (3) Generate your patch using Git tools out of your commits. |