SubmittingPatches: guidance for multi-series efforts
Occasionally there are efforts to contribute to the Git project that span more than one patch series in order to achieve a broader goal. By convention, the maintainer has typically suffixed the topic names with "-part-one", or "-part-1" and so on. Document that convention and suggest some guidance on how to structure proposed topic names for multi-series efforts. 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
1a41698841065f7911f31f20cd1ba9ec7c297aae
1 file changed
+8
Documentation/SubmittingPatches
+8
@@ -593,6 +593,14 @@ 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
+[[multi-series-efforts]]
597
+If your patch series is part of a larger effort spanning multiple
598
+patch series, briefly describe the broader goal, and state where the
599
+current series fits into that goal. If you are suggesting a topic
600
+name as in <<the-topic-summary, section above>>, consider
601
+"XX/the-broader-goal-part-one", "XX/the-broader-goal-part-two", and so
602
+on.
603
+
604
[[attachment]]
605
Do not attach the patch as a MIME attachment, compressed or not.
606
Do not let your e-mail client send quoted-printable. Do not let