* [PATCH v2 1/2] doc: encourage review replies before rerolling
2026-06-17 16:48 ` [PATCH v2 0/2] doc: clarify review replies and reroll timing Weijie Yuan
@ 2026-06-17 16:50 ` Weijie Yuan
2026-06-17 16:51 ` [PATCH v2 2/2] doc: advise batching patch rerolls Weijie Yuan
2026-06-21 8:04 ` [PATCH v3 0/2] doc: clarify review replies and reroll timing Weijie Yuan
2 siblings, 0 replies; 20+ messages in thread
From: Weijie Yuan @ 2026-06-17 16:50 UTC (permalink / raw)
To: git; +Cc: gitster, ps
Review feedback should not be answered only by sending a new patch
version. Encourage contributors to discuss their planned response in the
mailing-list thread before rerolling.
This makes the author's reasoning explicit before the next version is
prepared, instead of forcing reviewers to infer it from the rerolled
patches. It also encourages more direct social interaction between
contributors and helps foster a more collaborative review process.
Signed-off-by: Weijie Yuan <wy@wyuan.org>
---
Documentation/MyFirstContribution.adoc | 12 +++++++-----
Documentation/SubmittingPatches | 12 +++++++++---
2 files changed, 16 insertions(+), 8 deletions(-)
diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index b9fdefce02..00704ab91e 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -1337,11 +1337,13 @@ fewer mistakes were the only one they would need to review.
After a few days, you will hopefully receive a reply to your patchset with some
comments. Woohoo! Now you can get back to work.
-It's good manners to reply to each comment, notifying the reviewer that you have
-made the change suggested, feel the original is better, or that the comment
-inspired you to do something a new way which is superior to both the original
-and the suggested change. This way reviewers don't need to inspect your v2 to
-figure out whether you implemented their comment or not.
+It's good manners to reply to each comment in the mailing list discussion
+instead of letting the next version of your patch be your only response. Tell
+the reviewer whether you plan to make the suggested change, keep the original,
+or pursue a different approach. This way reviewers can respond to your reasoning
+before you spend time preparing a version they may not agree with, and later do
+not need to inspect your v2 to figure out whether you implemented their comment
+or not.
Reviewers may ask you about what you wrote in the patchset, either in
the proposed commit log message or in the changes themselves. You
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index f042bb5aaf..6c1e1f6423 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -48,8 +48,12 @@ area.
. You get comments and suggestions for improvements. You may even get
them in an "on top of your change" patch form. You are expected to
- respond to them with "Reply-All" on the mailing list, while taking
- them into account while preparing an updated set of patches.
+ respond to them with "Reply-All" on the mailing list, instead of
+ letting an updated patch series be your only response. Tell
+ reviewers which suggestions you plan to use, which ones you disagree
+ with, and when a comment leads you to consider a different approach.
+ Use these replies and any follow-up discussion as input when
+ preparing an updated set of patches.
+
It is often beneficial to allow some time for reviewers to provide
feedback before sending a new version, rather than sending an updated
@@ -613,7 +617,9 @@ grouped into their own e-mail thread to help readers find all parts of the
series. To that end, send them as replies to either an additional "cover
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.
+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.
If your log message (including your name on the
`Signed-off-by` trailer) is not writable in ASCII, make sure that
--
2.54.0
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH v2 2/2] doc: advise batching patch rerolls
2026-06-17 16:48 ` [PATCH v2 0/2] doc: clarify review replies and reroll timing Weijie Yuan
2026-06-17 16:50 ` [PATCH v2 1/2] doc: encourage review replies before rerolling Weijie Yuan
@ 2026-06-17 16:51 ` Weijie Yuan
2026-06-17 17:50 ` Junio C Hamano
2026-06-21 8:04 ` [PATCH v3 0/2] doc: clarify review replies and reroll timing Weijie Yuan
2 siblings, 1 reply; 20+ messages in thread
From: Weijie Yuan @ 2026-06-17 16:51 UTC (permalink / raw)
To: git; +Cc: gitster, ps
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, substantial rework, and how close the topic is to being accepted.
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>
---
Documentation/MyFirstContribution.adoc | 20 ++++++++++++++++++++
Documentation/SubmittingPatches | 12 ++++++++++--
2 files changed, 30 insertions(+), 2 deletions(-)
diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index 00704ab91e..f8f5f4e320 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -1330,6 +1330,26 @@ 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 require substantial rework, sending a new version
+sooner may save reviewers from spending time on a version you already know will
+change significantly. If the topic is close to being accepted and the remaining
+comments are small, a quicker new version may also be fine.
+
[[reviewing]]
=== Responding to Reviews
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 6c1e1f6423..13f180a8bd 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -58,7 +58,14 @@ 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, the depth of
+review, and how close the topic is to being accepted.
. These early update iterations are expected to be full replacements,
not incremental updates on top of what you posted already. If you
@@ -619,7 +626,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
--
2.54.0
^ permalink raw reply related [flat|nested] 20+ messages in thread
* Re: [PATCH v2 2/2] doc: advise batching patch rerolls
2026-06-17 16:51 ` [PATCH v2 2/2] doc: advise batching patch rerolls Weijie Yuan
@ 2026-06-17 17:50 ` Junio C Hamano
2026-06-19 13:20 ` Weijie Yuan
0 siblings, 1 reply; 20+ messages in thread
From: Junio C Hamano @ 2026-06-17 17:50 UTC (permalink / raw)
To: Weijie Yuan; +Cc: git, ps
Weijie Yuan <wy@wyuan.org> writes:
> +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.
All sensible up to this point.
> If the comments require substantial rework, sending a new version
> +sooner may save reviewers from spending time on a version you already know will
> +change significantly.
I am not sure about this one. Even though the intention to avoid
wasting reviewers' time spent on reading through the previous
version that will be invalidated is a good one, by definition, a
substantial rework will naturally take time, and it is better not to
rush and send an updated version with substantial changes that you
yourself haven't had a chance to thoroughly review yet.
In such a case, it would be a better idea to respond to the review
that made you realize a substantial rewrite is needed with a simple
"I'll make a substantial rework based on this comment, which would
invalidate this and that part of the current patch series, so please
do not waste reviewer cycles on these parts until I send an updated
series out" message.
> If the topic is close to being accepted and the remaining
> +comments are small, a quicker new version may also be fine.
I am not sure if this needs to be codified.
I often see (e.g., in patches from Patrick) that an iteration is
marked clearly as final candidate that the author is not aware of
any outstanding issues. This encourages reviewers to ask "what
about this one raised there?" to remind what is missed, or chime in
with "yup, this looks good" to show support. Such a note is highly
recommended, but I do not see a need to say "the (supposedly) final
one is specifically allowed to be sent without waiting" even then.
Thanks.
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [PATCH v2 2/2] doc: advise batching patch rerolls
2026-06-17 17:50 ` Junio C Hamano
@ 2026-06-19 13:20 ` Weijie Yuan
2026-06-24 11:46 ` Patrick Steinhardt
0 siblings, 1 reply; 20+ messages in thread
From: Weijie Yuan @ 2026-06-19 13:20 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git, ps
Sorry for the late reply. I spent some time looking back through the
discussions on earlier patch series, to check my patch itself, of course
because I'm apparently a newcomer here.
On Wed, Jun 17, 2026 at 10:50:53AM -0700, Junio C Hamano wrote:
> > If the comments require substantial rework, sending a new version
> > +sooner may save reviewers from spending time on a version you already know will
> > +change significantly.
>
> I am not sure about this one. Even though the intention to avoid
> wasting reviewers' time spent on reading through the previous
> version that will be invalidated is a good one, by definition, a
> substantial rework will naturally take time, and it is better not to
> rush and send an updated version with substantial changes that you
> yourself haven't had a chance to thoroughly review yet.
>
> In such a case, it would be a better idea to respond to the review
> that made you realize a substantial rewrite is needed with a simple
> "I'll make a substantial rework based on this comment, which would
> invalidate this and that part of the current patch series, so please
> do not waste reviewer cycles on these parts until I send an updated
> series out" message.
I think the approach you recommended is obviously more reasonable.
It would be better to give everyone a heads-up "I am working on a
new version."
I will improve this part accordingly.
> > If the topic is close to being accepted and the remaining
> > +comments are small, a quicker new version may also be fine.
>
> I am not sure if this needs to be codified.
>
> I often see (e.g., in patches from Patrick) that an iteration is
> marked clearly as final candidate that the author is not aware of
> any outstanding issues. This encourages reviewers to ask "what
> about this one raised there?" to remind what is missed, or chime in
> with "yup, this looks good" to show support. Such a note is highly
> recommended, but I do not see a need to say "the (supposedly) final
> one is specifically allowed to be sent without waiting" even then.
Actually I thought Patrick would say something here ;-) so I waited a
few more days to see whether anyone else had any suggestions.
But here I think Patrick's original intention is: If your series is
*close* to be accepted, (while I'm not sure what the precise definition
of this "close to be accepted", does it means: commented by Junio with
"Looks good", or reviewed by the community/core contributors with "Makes
sense"?) and this time there happens to be a small issue, you can
re-roll quickly to make your series more "sturdy" to wait for
maintainer's final examination and further merges.
So, I think the situation you are describing here is that this version
of the patch has already been declared by the *author* to be the final
version. (i.e. waiting for Junio to do the last exam)
Therefore, I do not think the two situations conflict with each other,
or are directly related. One concerns a patch that is already close to
receiving the maintainer's final verdict, where a minor issue is
discovered and the author quickly rerolls it. The other concerns an
author who, without realizing that some issues remain unresolved, rushes
to send what they believe to be the final version and then waits for the
maintainer to review it.
For the latter case, I think it would be better to add a sentence along
the lines of: "Before sending a new version/the final version, check
once more whether there are any unresolved issues," if the existing
documentation does not already make this clear.
That said, I am not familiar with how patch discussions have played out
in the past, so please directly point out any mistakes in my
understanding. I have to admit that, by this point in writing the
message, I have become a little tangled up in my own reasoning.
Thanks!
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [PATCH v2 2/2] doc: advise batching patch rerolls
2026-06-19 13:20 ` Weijie Yuan
@ 2026-06-24 11:46 ` Patrick Steinhardt
0 siblings, 0 replies; 20+ messages in thread
From: Patrick Steinhardt @ 2026-06-24 11:46 UTC (permalink / raw)
To: Weijie Yuan; +Cc: Junio C Hamano, git
On Fri, Jun 19, 2026 at 09:20:15PM +0800, Weijie Yuan wrote:
> Sorry for the late reply. I spent some time looking back through the
> discussions on earlier patch series, to check my patch itself, of course
> because I'm apparently a newcomer here.
>
> On Wed, Jun 17, 2026 at 10:50:53AM -0700, Junio C Hamano wrote:
> > > If the comments require substantial rework, sending a new version
> > > +sooner may save reviewers from spending time on a version you already know will
> > > +change significantly.
> >
> > I am not sure about this one. Even though the intention to avoid
> > wasting reviewers' time spent on reading through the previous
> > version that will be invalidated is a good one, by definition, a
> > substantial rework will naturally take time, and it is better not to
> > rush and send an updated version with substantial changes that you
> > yourself haven't had a chance to thoroughly review yet.
> >
> > In such a case, it would be a better idea to respond to the review
> > that made you realize a substantial rewrite is needed with a simple
> > "I'll make a substantial rework based on this comment, which would
> > invalidate this and that part of the current patch series, so please
> > do not waste reviewer cycles on these parts until I send an updated
> > series out" message.
>
> I think the approach you recommended is obviously more reasonable.
>
> It would be better to give everyone a heads-up "I am working on a
> new version."
>
> I will improve this part accordingly.
Yeah, that works for me, as well.
> > > If the topic is close to being accepted and the remaining
> > > +comments are small, a quicker new version may also be fine.
> >
> > I am not sure if this needs to be codified.
> >
> > I often see (e.g., in patches from Patrick) that an iteration is
> > marked clearly as final candidate that the author is not aware of
> > any outstanding issues. This encourages reviewers to ask "what
> > about this one raised there?" to remind what is missed, or chime in
> > with "yup, this looks good" to show support. Such a note is highly
> > recommended, but I do not see a need to say "the (supposedly) final
> > one is specifically allowed to be sent without waiting" even then.
>
> Actually I thought Patrick would say something here ;-) so I waited a
> few more days to see whether anyone else had any suggestions.
>
> But here I think Patrick's original intention is: If your series is
> *close* to be accepted, (while I'm not sure what the precise definition
> of this "close to be accepted", does it means: commented by Junio with
> "Looks good", or reviewed by the community/core contributors with "Makes
> sense"?) and this time there happens to be a small issue, you can
> re-roll quickly to make your series more "sturdy" to wait for
> maintainer's final examination and further merges.
>
> So, I think the situation you are describing here is that this version
> of the patch has already been declared by the *author* to be the final
> version. (i.e. waiting for Junio to do the last exam)
My "close to be accepted" feeling is when you've had multiple rounds of
design discussions already, everyone is on the same page, and all you
got on the last review round is a couple of typo fixes.
But all of this is highly subjective, so it'll always depend and it
won't be easy to codify all of that. Nor is that necessary, I guess. We
really only want to provide some rough guidance.
> Therefore, I do not think the two situations conflict with each other,
> or are directly related. One concerns a patch that is already close to
> receiving the maintainer's final verdict, where a minor issue is
> discovered and the author quickly rerolls it. The other concerns an
> author who, without realizing that some issues remain unresolved, rushes
> to send what they believe to be the final version and then waits for the
> maintainer to review it.
>
> For the latter case, I think it would be better to add a sentence along
> the lines of: "Before sending a new version/the final version, check
> once more whether there are any unresolved issues," if the existing
> documentation does not already make this clear.
I think that should mostly be clear with our documentation. And
eventually, we should also expect people to have some common sense :)
> That said, I am not familiar with how patch discussions have played out
> in the past, so please directly point out any mistakes in my
> understanding. I have to admit that, by this point in writing the
> message, I have become a little tangled up in my own reasoning.
I guess that's kind of expected, mostly because many of these things are
highly subjective and will depend on the situation. The guidance does
not have to be perfect, you'll probably be able to find counterexamples
for many of the cases.
Patrick
^ permalink raw reply [flat|nested] 20+ messages in thread
* [PATCH v3 0/2] doc: clarify review replies and reroll timing
2026-06-17 16:48 ` [PATCH v2 0/2] doc: clarify review replies and reroll timing Weijie Yuan
2026-06-17 16:50 ` [PATCH v2 1/2] doc: encourage review replies before rerolling Weijie Yuan
2026-06-17 16:51 ` [PATCH v2 2/2] doc: advise batching patch rerolls Weijie Yuan
@ 2026-06-21 8:04 ` Weijie Yuan
2026-06-21 8:05 ` [PATCH v3 1/2] doc: encourage review replies before rerolling Weijie Yuan
` (2 more replies)
2 siblings, 3 replies; 20+ messages in thread
From: Weijie Yuan @ 2026-06-21 8:04 UTC (permalink / raw)
To: git; +Cc: gitster, ps
This small series updates the 2 documentations: MyFirstContribution and
SubmittingPatches.
The first patch clarifies that review feedback should not be answered
only by sending a new version of the patches, which is talked in [1].
Contributors are encouraged to and should discuss their planned response in
the existing review thread, so that the next version does not become the
only place where reviewers can infer the author's reasoning.
The second patch is originally from an email from Patrick [2], which
documents a rough expectation around reroll frequency.
Patrick suggests: There is no hard rule for when to send a new version,
but batching feedback and avoiding multiple rerolls of the same series
in a single day is a useful default. The text also mentions factors that
may affect this, such as the size of the series, the depth of review,
and whether the topic is close to being picked up.
(Edit: the last point is discussed by Junio[3], which is improved in v3)
Since I am the newbie here, please tell me how to attribute the credit
to Patrick. Thank you Patrick!
(Edit: finished with the Helped-by trailer in v2)
[1]: <xmqq7bo5nf31.fsf@gitster.g>
[2]: <aietF4BX1Ewt3cpG@pks.im>
[3]: <xmqq4ij1vywy.fsf@gitster.g>
---
Changes in v3:
- Reworked the substantial-rework case. Instead of suggesting that
authors send a new version sooner, the text now advises authors not
to rush out an updated version before reviewing the larger changes
carefully. It recommends replying to the review that prompted the
rewrite, saying that a substantial rework is planned, and pointing
out which parts of the current series will become obsolete.
- Dropped the advice that a topic close to being accepted may justify
a quicker reroll.
- Removed "how close the topic is to being accepted" from the short
reroll-timing guidance in Documentation/SubmittingPatches.
- Updated the commit message of patch 2 accordingly.
Changes in v2:
For [PATCH 1/2] doc: encourage review replies before rerolling:
- Add "social interactions" in commit message.
I didn't do any changes for Patrick's comments in [a]:
> I feel like the new version doesn't really add anything significant
> to this paragraph that it didn't already say before your patch, but
> it does so with more words.
> I'm of course biased though, so maybe more words help newcomers?
Thinking about whether to delete/revert or not. Comments welcome.
For [PATCH 2/2] doc: advise batching patch rerolls:
- Add a trailer to thank Patrick.
Suggestions from Junio:
- Mention that waiting between rerolls gives reviewers across time
zones a fair chance to participate.
- Mention that waiting also encourages authors to polish patches
before sending them.
[a] <ai_7Wh7hrD8PZozg@pks.im>
---
base commit: 700432b2ba (topic flush before -rc1 (batch 1), 2026-06-15)
Weijie Yuan (2):
doc: encourage review replies before rerolling
doc: advise batching patch rerolls
Documentation/MyFirstContribution.adoc | 34 ++++++++++++++++++++++----
Documentation/SubmittingPatches | 23 ++++++++++++++---
2 files changed, 48 insertions(+), 9 deletions(-)
Range-diff against v2:
1: 4bb1efe71d = 1: 4bb1efe71d doc: encourage review replies before rerolling
2: 496a08c74d ! 2: e1050a6ef5 doc: advise batching patch rerolls
@@ Commit message
time to comment regardless of their time zones.
Mention factors that can affect the timing, such as series size, review
- depth, substantial rework, and how close the topic is to being accepted.
- Also point out that avoiding rapid rerolls encourages authors to polish
- each version before sending it, so reviewers can focus on substantial
- issues.
+ 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>
@@ Documentation/MyFirstContribution.adoc: previous one" patches over 2 days), revi
+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 require substantial rework, sending a new version
-+sooner may save reviewers from spending time on a version you already know will
-+change significantly. If the topic is close to being accepted and the remaining
-+comments are small, a quicker new version may also be fine.
++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]]
@@ Documentation/SubmittingPatches: area.
-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.
++encourages you to polish each version before sending it, so reviewers
++can focus on substantial issues rather than typos or other small
++mistakes. (only changes textwidth here)
++
+As a rough default, avoid sending more than one new version of the same
-+series per day, while considering the size of the series, the depth of
-+review, and how close the topic is to being accepted.
++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
--
2.54.0
^ permalink raw reply [flat|nested] 20+ messages in thread* [PATCH v3 1/2] doc: encourage review replies before rerolling
2026-06-21 8:04 ` [PATCH v3 0/2] doc: clarify review replies and reroll timing Weijie Yuan
@ 2026-06-21 8:05 ` Weijie Yuan
2026-06-21 8:05 ` [PATCH v3 2/2] doc: advise batching patch rerolls Weijie Yuan
2026-06-24 11:47 ` [PATCH v3 0/2] doc: clarify review replies and reroll timing Patrick Steinhardt
2 siblings, 0 replies; 20+ messages in thread
From: Weijie Yuan @ 2026-06-21 8:05 UTC (permalink / raw)
To: git; +Cc: gitster, ps
Review feedback should not be answered only by sending a new patch
version. Encourage contributors to discuss their planned response in the
mailing-list thread before rerolling.
This makes the author's reasoning explicit before the next version is
prepared, instead of forcing reviewers to infer it from the rerolled
patches. It also encourages more direct social interaction between
contributors and helps foster a more collaborative review process.
Signed-off-by: Weijie Yuan <wy@wyuan.org>
---
Documentation/MyFirstContribution.adoc | 12 +++++++-----
Documentation/SubmittingPatches | 12 +++++++++---
2 files changed, 16 insertions(+), 8 deletions(-)
diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index b9fdefce02..00704ab91e 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -1337,11 +1337,13 @@ fewer mistakes were the only one they would need to review.
After a few days, you will hopefully receive a reply to your patchset with some
comments. Woohoo! Now you can get back to work.
-It's good manners to reply to each comment, notifying the reviewer that you have
-made the change suggested, feel the original is better, or that the comment
-inspired you to do something a new way which is superior to both the original
-and the suggested change. This way reviewers don't need to inspect your v2 to
-figure out whether you implemented their comment or not.
+It's good manners to reply to each comment in the mailing list discussion
+instead of letting the next version of your patch be your only response. Tell
+the reviewer whether you plan to make the suggested change, keep the original,
+or pursue a different approach. This way reviewers can respond to your reasoning
+before you spend time preparing a version they may not agree with, and later do
+not need to inspect your v2 to figure out whether you implemented their comment
+or not.
Reviewers may ask you about what you wrote in the patchset, either in
the proposed commit log message or in the changes themselves. You
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index f042bb5aaf..6c1e1f6423 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -48,8 +48,12 @@ area.
. You get comments and suggestions for improvements. You may even get
them in an "on top of your change" patch form. You are expected to
- respond to them with "Reply-All" on the mailing list, while taking
- them into account while preparing an updated set of patches.
+ respond to them with "Reply-All" on the mailing list, instead of
+ letting an updated patch series be your only response. Tell
+ reviewers which suggestions you plan to use, which ones you disagree
+ with, and when a comment leads you to consider a different approach.
+ Use these replies and any follow-up discussion as input when
+ preparing an updated set of patches.
+
It is often beneficial to allow some time for reviewers to provide
feedback before sending a new version, rather than sending an updated
@@ -613,7 +617,9 @@ grouped into their own e-mail thread to help readers find all parts of the
series. To that end, send them as replies to either an additional "cover
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.
+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.
If your log message (including your name on the
`Signed-off-by` trailer) is not writable in ASCII, make sure that
--
2.54.0
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [PATCH v3 2/2] doc: advise batching patch rerolls
2026-06-21 8:04 ` [PATCH v3 0/2] doc: clarify review replies and reroll timing Weijie Yuan
2026-06-21 8:05 ` [PATCH v3 1/2] doc: encourage review replies before rerolling Weijie Yuan
@ 2026-06-21 8:05 ` Weijie Yuan
2026-06-24 11:46 ` Patrick Steinhardt
2026-06-24 11:47 ` [PATCH v3 0/2] doc: clarify review replies and reroll timing Patrick Steinhardt
2 siblings, 1 reply; 20+ messages in thread
From: Weijie Yuan @ 2026-06-21 8:05 UTC (permalink / raw)
To: git; +Cc: gitster, ps
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>
---
Documentation/MyFirstContribution.adoc | 22 ++++++++++++++++++++++
Documentation/SubmittingPatches | 13 +++++++++++--
2 files changed, 33 insertions(+), 2 deletions(-)
diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
index 00704ab91e..35105bc3b4 100644
--- a/Documentation/MyFirstContribution.adoc
+++ b/Documentation/MyFirstContribution.adoc
@@ -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
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 6c1e1f6423..d89efe0707 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -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
--
2.54.0
^ permalink raw reply related [flat|nested] 20+ messages in thread
* Re: [PATCH v3 2/2] doc: advise batching patch rerolls
2026-06-21 8:05 ` [PATCH v3 2/2] doc: advise batching patch rerolls Weijie Yuan
@ 2026-06-24 11:46 ` Patrick Steinhardt
0 siblings, 0 replies; 20+ messages in thread
From: Patrick Steinhardt @ 2026-06-24 11:46 UTC (permalink / raw)
To: Weijie Yuan; +Cc: git, gitster
On Sun, Jun 21, 2026 at 04:05:34PM +0800, Weijie Yuan wrote:
> diff --git a/Documentation/MyFirstContribution.adoc b/Documentation/MyFirstContribution.adoc
> index 00704ab91e..35105bc3b4 100644
> --- a/Documentation/MyFirstContribution.adoc
> +++ b/Documentation/MyFirstContribution.adoc
> @@ -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.
Makes sense.
Patrick
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [PATCH v3 0/2] doc: clarify review replies and reroll timing
2026-06-21 8:04 ` [PATCH v3 0/2] doc: clarify review replies and reroll timing Weijie Yuan
2026-06-21 8:05 ` [PATCH v3 1/2] doc: encourage review replies before rerolling Weijie Yuan
2026-06-21 8:05 ` [PATCH v3 2/2] doc: advise batching patch rerolls Weijie Yuan
@ 2026-06-24 11:47 ` Patrick Steinhardt
2 siblings, 0 replies; 20+ messages in thread
From: Patrick Steinhardt @ 2026-06-24 11:47 UTC (permalink / raw)
To: Weijie Yuan; +Cc: git, gitster
On Sun, Jun 21, 2026 at 04:04:36PM +0800, Weijie Yuan wrote:
> Changes in v3:
>
> - Reworked the substantial-rework case. Instead of suggesting that
> authors send a new version sooner, the text now advises authors not
> to rush out an updated version before reviewing the larger changes
> carefully. It recommends replying to the review that prompted the
> rewrite, saying that a substantial rework is planned, and pointing
> out which parts of the current series will become obsolete.
>
> - Dropped the advice that a topic close to being accepted may justify
> a quicker reroll.
>
> - Removed "how close the topic is to being accepted" from the short
> reroll-timing guidance in Documentation/SubmittingPatches.
>
> - Updated the commit message of patch 2 accordingly.
I'm happy with this version, thanks!
Patrick
^ permalink raw reply [flat|nested] 20+ messages in thread