Skip to content

Commit 476365a

Browse files
committed
SubmittingPatches: spell out "replace fully to pretend to be perfect"
It unfortunately is a recurring theme that new developers tend to pile more "fixup" patches on top of the already reviewed patches, making the topic longer and keeping the history of all wrong turns, which interests nobody in the larger picture. Even picking a narrow search in the list archive for "pretend to be a perfect " substring, we find these: https://lore.kernel.org/git/xmqqk29bsz2o.fsf@gitster.mtv.corp.google.com/ https://lore.kernel.org/git/xmqqd0ds5ysq.fsf@gitster-ct.c.googlers.com/ https://lore.kernel.org/git/xmqqr173faez.fsf@gitster.g/ The SubmittingPatches guide does talk about going incremental once a topic hits the 'next' branch, but it does not say much about how a new iteration of the topic should be prepared before that happens, and it does not mention that the developers are encouraged to seize the opportunity to pretend to be perfect with a full replacement set of patches. Add a new paragraph to stress this point in the section that describes the life-cycle of a patch series. Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 67ad421 commit 476365a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

Documentation/SubmittingPatches

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,18 @@ help you find out who they are.
4343
respond to them with "Reply-All" on the mailing list, while taking
4444
them into account while preparing an updated set of patches.
4545

46+
. These early update iterations are expected to be full replacements,
47+
not incremental updates on top of what you posted already. If you
48+
are correcting mistakes you made in the previous iteration that a
49+
reviewer noticed and pointed out in their review, you _fix_ that
50+
mistake by rewriting your history (e.g., by using "git rebase -i")
51+
to pretend that you never made the mistake in the first place. In
52+
other words, this is a chance to pretend to be a perfect developer,
53+
and you are expected to take advantage of that. In the larger
54+
picture, nobody is interested in your earlier mistakes. Just
55+
present a logical progression made by a perfect developer who makes
56+
no mistakes while working on the topic.
57+
4658
. Polish, refine, and re-send your patches to the list and to the people
4759
who spent their time to improve your patch. Go back to step (2).
4860

0 commit comments

Comments
 (0)