]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Documentation/MyFirstContribution: recommend shallow threading
authorPatrick Steinhardt <ps@pks.im>
Wed, 3 Jun 2026 06:58:59 +0000 (08:58 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 3 Jun 2026 07:39:02 +0000 (16:39 +0900)
The "MyFirstContribution" document recommends the use of deep threading:
every cover letter of subsequent iterations shall be linked to the cover
letter of the preceding version. The result of this is that eventually,
threads with many versions are getting nested so deep that it becomes
hard to follow.

Adapt the recommendation to instead propose shallow threading: instead
of linking the cover letter to the previous cover letter, the user is
supposed to always link it to the first cover letter. This still makes
it easy to follow the iterations, but has the benefit of nesting to a
much shallower level.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/MyFirstContribution.adoc

index b9fdefce0224c90abcf566faa057c81d7945b6d9..069020196c0e2d792910932c77c6357509eebfa0 100644 (file)
@@ -1227,8 +1227,8 @@ Message-ID: <foo.12345.author@example.com>
 
 Your Message-ID is `<foo.12345.author@example.com>`. This example will be used
 below as well; make sure to replace it with the correct Message-ID for your
-**previous cover letter** - that is, if you're sending v2, use the Message-ID
-from v1; if you're sending v3, use the Message-ID from v2.
+**first cover letter** - that is, for any subsequent version that you send,
+always use the Message-ID from v1.
 
 While you're looking at the email, you should also note who is CC'd, as it's
 common practice in the mailing list to keep all CCs on a thread. You can add