Skip to content

Commit b94b1f9

Browse files
committed
Merge branch 'jc/do-not-just-explain-but-update-your-patch'
Expectation for the original contributor after responding to a review comment to use the explanation in a patch update has been described. * jc/do-not-just-explain-but-update-your-patch: MyFirstContribition: answering questions is not the end of the story
2 parents f73ee0c + a6d8d11 commit b94b1f9

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

Documentation/MyFirstContribution.txt

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1143,11 +1143,25 @@ After a few days, you will hopefully receive a reply to your patchset with some
11431143
comments. Woohoo! Now you can get back to work.
11441144

11451145
It's good manners to reply to each comment, notifying the reviewer that you have
1146-
made the change requested, feel the original is better, or that the comment
1146+
made the change suggested, feel the original is better, or that the comment
11471147
inspired you to do something a new way which is superior to both the original
11481148
and the suggested change. This way reviewers don't need to inspect your v2 to
11491149
figure out whether you implemented their comment or not.
11501150

1151+
Reviewers may ask you about what you wrote in the patchset, either in
1152+
the proposed commit log message or in the changes themselves. You
1153+
should answer these questions in your response messages, but often the
1154+
reason why reviewers asked these questions to understand what you meant
1155+
to write is because your patchset needed clarification to be understood.
1156+
1157+
Do not be satisfied by just answering their questions in your response
1158+
and hear them say that they now understand what you wanted to say.
1159+
Update your patches to clarify the points reviewers had trouble with,
1160+
and prepare your v2; the words you used to explain your v1 to answer
1161+
reviewers' questions may be useful thing to use. Your goal is to make
1162+
your v2 clear enough so that it becomes unnecessary for you to give the
1163+
same explanation to the next person who reads it.
1164+
11511165
If you are going to push back on a comment, be polite and explain why you feel
11521166
your original is better; be prepared that the reviewer may still disagree with
11531167
you, and the rest of the community may weigh in on one side or the other. As

0 commit comments

Comments
 (0)