doc: advise batching patch rerolls

Contributors often need guidance on how quickly to send later iterations
of a patch series. Add a rough default of no more than one new version
of the same series per day so feedback can be batched and reviewers have
time to comment regardless of their time zones.

Mention factors that can affect the timing, such as series size, review
depth, and substantial rework. Also point out that avoiding rapid
rerolls encourages authors to polish each version before sending it, so
reviewers can focus on substantial issues.

Helped-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Weijie Yuan <wy@wyuan.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Weijie Yuan
2026-06-21 16:05:34 +08:00
committed by Junio C Hamano
parent 7bcc64be77
commit 4771726361
2 changed files with 33 additions and 2 deletions

View File

@@ -1330,6 +1330,28 @@ previous one" patches over 2 days), reviewers would strongly prefer if a
single polished version came 2 days later instead, and that version with
fewer mistakes were the only one they would need to review.
This consideration applies not only when going from the initial patch to v2,
but also to later iterations of the same series. There is no fixed rule for how
long to wait before sending a new version. A useful default is to send at most
one new version of the same patch series per day. This gives multiple reviewers
time to comment, gives reviewers across time zones a fair chance to
participate, lets you batch feedback together, and gives you time to think
through the comments you received. Knowing that you should not immediately send
another version also encourages you to review the patches more carefully before
sending them, catch small mistakes such as typos and off-by-one errors
yourself, and let reviewers spend more of their attention on design,
algorithms, and other substantial issues.
The right timing depends on the topic and the feedback. Larger series usually
need more review time. If the only comments so far are minor, such as typo
fixes, it often makes sense to wait a little longer in case deeper reviews are
still coming. If the comments call for substantial rework, do not rush out an
updated version before you have reviewed the larger changes carefully. Instead,
reply to the review that prompted the rewrite, say that you are preparing a
substantial rework, and mention which parts of the current series will become
obsolete so reviewers can avoid spending time on them until the updated series
is ready.
[[reviewing]]
=== Responding to Reviews

View File

@@ -58,7 +58,15 @@ area.
It is often beneficial to allow some time for reviewers to provide
feedback before sending a new version, rather than sending an updated
series immediately after receiving a review. This helps collect broader
input and avoids unnecessary churn from many rapid iterations.
input, gives reviewers in different time zones a fair chance to comment,
and avoids unnecessary churn from many rapid iterations. Waiting also
encourages you to polish each version before sending it, so reviewers
can focus on substantial issues rather than typos or other small
mistakes.
+
As a rough default, avoid sending more than one new version of the same
series per day, while considering the size of the series and the depth
of review.
. These early update iterations are expected to be full replacements,
not incremental updates on top of what you posted already. If you
@@ -619,7 +627,8 @@ letter" message (see below), the first patch, or the respective preceding patch.
Here is a link:MyFirstContribution.html#v2-git-send-email[step-by-step guide] on
how to submit updated versions of a patch series. Before sending another
version, make sure you have answered meaningful review comments in the existing
discussion.
discussion. Also give reviewers enough time to comment before sending another
version.
If your log message (including your name on the
`Signed-off-by` trailer) is not writable in ASCII, make sure that