Skip to content

Commit 1204017

Browse files
committed
SubmittingPatches: address design critiques
Contributors sometimes fail to answer fundamental design or viability comments from reviewers and submit subsequent rounds without addressing them. When design decisions are resolved on the mailing list, the final justification should be recorded in the commit messages. Instruct authors to be particularly mindful of critiques regarding high-level design or viability, to defend their choices on the list, and to accompany new iterations with clearer explanations in the cover letter, responses, and revised commit messages. Also instruct them to explicitly document the resolution of these concerns in the commit message body to keep the historical record complete. Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 4621f8c commit 1204017

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

Documentation/SubmittingPatches

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,21 @@ area.
5151
respond to them with "Reply-All" on the mailing list, while taking
5252
them into account while preparing an updated set of patches.
5353
+
54+
Be particularly mindful of critiques regarding the high-level design
55+
or viability of your proposal (e.g., questioning if the feature is
56+
worth implementing, or if the chosen approach is appropriate). Defend
57+
your design decisions on the list first, work with reviewers and other
58+
members to improve the design before revising the implementation, to
59+
avoid wasting effort on an implementation before its design is solid.
60+
+
61+
Make sure that any new version explains and justifies those design
62+
decisions more clearly, in the cover letter and in the revised commit
63+
messages. Aim to make the reviewers say "it is now clear why we may
64+
want to do this with the updated version".
65+
+
66+
Topics with unresolved fundamental design critiques will not be
67+
considered ready for merging.
68+
+
5469
It is often beneficial to allow some time for reviewers to provide
5570
feedback before sending a new version, rather than sending an updated
5671
series immediately after receiving a review. This helps collect broader
@@ -323,6 +338,10 @@ The body should provide a meaningful commit message, which:
323338

324339
. alternate solutions considered but discarded, if any.
325340

341+
. records the resolution of design or viability concerns raised by the
342+
community during the review, if any, ensuring the historical record
343+
explains why the chosen approach was accepted over alternatives.
344+
326345
[[present-tense]]
327346
The problem statement that describes the status quo is written in the
328347
present tense. Write "The code does X when it is given input Y",

0 commit comments

Comments
 (0)