]> git.ipfire.org Git - thirdparty/git.git/blobdiff - Documentation/SubmittingPatches
Merge branch 'la/doc-use-of-contacts-when-contributing'
[thirdparty/git.git] / Documentation / SubmittingPatches
index b684e28c0d01d12cc23b37cb1de962854138a659..e70a9a0f353097e5537d9212505d925c3a5b8188 100644 (file)
@@ -499,6 +499,18 @@ an explanation of changes between each iteration can be kept in
 Git-notes and inserted automatically following the three-dash
 line via `git format-patch --notes`.
 
+[[the-topic-summary]]
+*This is EXPERIMENTAL*.
+
+When sending a topic, you can propose a one-paragraph summary that
+should appear in the "What's cooking" report when it is picked up to
+explain the topic.  If you choose to do so, please write a 2-5 line
+paragraph that will fit well in our release notes (see many bulleted
+entries in the Documentation/RelNotes/* files for examples), and make
+it the first paragraph of the cover letter.  For a single-patch
+series, use the space between the three-dash line and the diffstat, as
+described earlier.
+
 [[attachment]]
 Do not attach the patch as a MIME attachment, compressed or not.
 Do not let your e-mail client send quoted-printable.  Do not let