diff options
author | Junio C Hamano <gitster@pobox.com> | 2024-04-03 17:56:19 (GMT) |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2024-04-03 17:56:19 (GMT) |
commit | eda72ddc18766a89705d5d4e6ba7388a93e4c8e6 (patch) | |
tree | cb5740a3212da553dcd9f65003c7ca402ab1ad51 /Documentation | |
parent | e139bb100691d7e60688ad536ee9966d144388f0 (diff) | |
parent | d255105c99373052353582d4552f15bce5acaf13 (diff) | |
download | git-eda72ddc18766a89705d5d4e6ba7388a93e4c8e6.zip git-eda72ddc18766a89705d5d4e6ba7388a93e4c8e6.tar.gz git-eda72ddc18766a89705d5d4e6ba7388a93e4c8e6.tar.bz2 |
Merge branch 'jc/release-notes-entry-experiment'
Introduce an experimental protocol for contributors to propose the
topic description to be used in the "What's cooking" report, the
merge commit message for the topic, and in the release notes and
document it in the SubmittingPatches document.
* jc/release-notes-entry-experiment:
SubmittingPatches: release-notes entry experiment
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/SubmittingPatches | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches index e734a3f..c647c7e 100644 --- a/Documentation/SubmittingPatches +++ b/Documentation/SubmittingPatches @@ -459,6 +459,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 |