Skip to content

Commit a190f01

Browse files
jltoblergitster
authored andcommitted
Documentation: extend guidance for submitting patches
Before submitting patches on the mailing list, it is often a good idea to check for previous related discussions or if similar work is already in progress. This enables better coordination amongst contributors and could avoid duplicating work. Additionally, it is often recommended to give reviewers some time to reply to a patch series before sending new versions. This helps collect broader feedback and reduces unnecessary churn from rapid rerolls. Document this guidance in "Documentation/SubmittingPatches" accordingly. Signed-off-by: Justin Tobler <jltobler@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 795c338 commit a190f01

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

Documentation/SubmittingPatches

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,24 @@ most likely to be knowledgeable enough to help you, but
3737
they have no obligation to help you (i.e. you ask them for help,
3838
you don't demand). +git log -p {litdd} _$area_you_are_modifying_+ would
3939
help you find out who they are.
40+
+
41+
It is also a good idea to check whether your topic has been discussed
42+
previously on the mailing list, or whether similar work is already in
43+
progress. Prior discussions may contain useful context, design
44+
considerations, or earlier attempts at solving the same problem. Being
45+
aware of such discussions can help you avoid duplicating work and may
46+
allow you to coordinate with other contributors working in the same
47+
area.
4048

4149
. You get comments and suggestions for improvements. You may even get
4250
them in an "on top of your change" patch form. You are expected to
4351
respond to them with "Reply-All" on the mailing list, while taking
4452
them into account while preparing an updated set of patches.
53+
+
54+
It is often beneficial to allow some time for reviewers to provide
55+
feedback before sending a new version, rather than sending an updated
56+
series immediately after receiving a review. This helps collect broader
57+
input and avoids unnecessary churn from many rapid iterations.
4558

4659
. Polish, refine, and re-send your patches to the list and to the people
4760
who spent their time to improve your patch. Go back to step (2).

0 commit comments

Comments
 (0)