SubmittingPatches: extend release-notes experiment to topic names
In d255105c99 (SubmittingPatches: release-notes entry experiment, 2024-03-25), we began an experiment to have contributors suggest a topic description to appear in our RelNotes and "What's cooking?" reports. Extend that experiment to also welcome suggested topic branch names in addition to descriptions. Suggested-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Taylor Blau <me@ttaylorr.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Taylor Blau committed
Oct 7, 2025 at 17:39 UTC
881445157279bc2319b7b3c1392d5083453f4662
1 file changed
+13
-8
Documentation/SubmittingPatches
+13
-8
@@ -579,14 +579,19 @@ line via `git format-patch --notes`.
579
[[the-topic-summary]]
580
*This is EXPERIMENTAL*.
581
582
-When sending a topic, you can propose a one-paragraph summary that
583
-should appear in the "What's cooking" report when it is picked up to
584
-explain the topic. If you choose to do so, please write a 2-5 line
585
-paragraph that will fit well in our release notes (see many bulleted
586
-entries in the Documentation/RelNotes/* files for examples), and make
587
-it the first paragraph of the cover letter. For a single-patch
588
-series, use the space between the three-dash line and the diffstat, as
589
-described earlier.
582
+When sending a topic, you can optionally propose a topic name and/or a
583
+one-paragraph summary that should appear in the "What's cooking"
584
+report when it is picked up to explain the topic. If you choose to do
585
+so, please write a 2-5 line paragraph that will fit well in our
586
+release notes (see many bulleted entries in the
587
+Documentation/RelNotes/* files for examples), and make it the first
588
+(or second, if including a suggested topic name) paragraph of the
589
+cover letter. If suggesting a topic name, use the format
590
+"XX/your-topic-name", where "XX" is a stand-in for the primary
591
+author's initials, and "your-topic-name" is a brief, dash-delimited
592
+description of what your topic does. For a single-patch series, use
593
+the space between the three-dash line and the diffstat, as described
594
+earlier.
595
596
[[attachment]]
597
Do not attach the patch as a MIME attachment, compressed or not.