Skip to content

Commit 1a41698

Browse files
ttaylorrgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Taylor Blau <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 8814451 commit 1a41698

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

Documentation/SubmittingPatches

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -593,6 +593,14 @@ description of what your topic does. For a single-patch series, use
593593
the space between the three-dash line and the diffstat, as described
594594
earlier.
595595

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+
596604
[[attachment]]
597605
Do not attach the patch as a MIME attachment, compressed or not.
598606
Do not let your e-mail client send quoted-printable. Do not let

0 commit comments

Comments
 (0)