Skip to contentSkip to conversation

myFirstContribition: answering questions is not the end of the story

PATCH In review Junio C Hamano 4 participants 7 messages Nov 20, 2020 – Dec 1, 2020 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 myFirstContribition: answering questions is not the end of the story

A review exchange may begin with a reviewer asking "what did you mean by this phrase in your log message (or here in the doc)?", the author answering what was meant, and then the reviewer saying "ah, that is what you meant---then the flow of the logic makes sense".

But that is not the happy end of the story. New contributors often forget that the material that has been reviewed in the above exchange is still unclear in the same way to the next person who reads it, until it gets updated.

While we are in the vicinity, rephrase the verb "request" used to refer to comments by reviewers to "suggest"---this matches the contrast between "original" and "suggested" that appears later in the same paragraph, and more importantly makes it clearer that it is not like authors are to please reviewers' wishes but rather reviewers are merely helping authors to polish their commits.

---

* Something along this line, in a more condensed form, may also want to be in SubmittingPatches, but let's start with a longer form that is easier to discuss the intent of the addition to see if it is a good idea. I've seen a patch that got reviewed falling thru the cracks without producing a v2 too many times.

 Documentation/MyFirstContribution.txt | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)
Documentation/MyFirstContribution.txt +14 -1
index 60eed5edcd..bac4997e39 100644
@@ -1143,11 +1143,24 @@ 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 requested, feel the original is better, or that the comment
+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.
 
+Reviewers may ask you about what you wrote in the patchset, either in
+the proposed commit log message or in the changes themselves.  You
+should answer these questions in your response messages, but often the
+reason why reviewers asked these questions to understand what you meant
+to write is because your patchset needed clarification to be understood.
+Do not be satisfied by just answering their questions in your response
+and hear them say that they now understand what you wanted to say.
+Update your patches to clarify the points reviewers had trouble with,
+and prepare your v2; the words you used to explain your v1 to answer
+reviewers' questions may be useful thing to use.  Your goal is to make
+your v2 clear enough so that it becomes unnecessary for you to give the
+same explanation to the next person who reads it.
+
 If you are going to push back on a comment, be polite and explain why you feel
 your original is better; be prepared that the reviewer may still disagree with
 you, and the rest of the community may weigh in on one side or the other. As
Reviewed-by on v1 1/1
#1 lore raw
Quoted 9 lines · Junio C Hamano

A review exchange may begin with a reviewer asking "what did you mean by this phrase in your log message (or here in the doc)?", the author answering what was meant, and then the reviewer saying "ah, that is what you meant---then the flow of the logic makes sense".

But that is not the happy end of the story. New contributors often forget that the material that has been reviewed in the above exchange is still unclear in the same way to the next person who reads it, until it gets updated.

Yes!

Quoted 28 lines

While we are in the vicinity, rephrase the verb "request" used to refer to comments by reviewers to "suggest"---this matches the contrast between "original" and "suggested" that appears later in the same paragraph, and more importantly makes it clearer that it is not like authors are to please reviewers' wishes but rather reviewers are merely helping authors to polish their commits.

---

* Something along this line, in a more condensed form, may also want to be in SubmittingPatches, but let's start with a longer form that is easier to discuss the intent of the addition to see if it is a good idea. I've seen a patch that got reviewed falling thru the cracks without producing a v2 too many times.

 Documentation/MyFirstContribution.txt | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)
Documentation/MyFirstContribution.txt +0 -1
index 60eed5edcd..bac4997e39 100644
@@ -1143,11 +1143,24 @@ 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 requested, feel the original is better, or that the comment

Documentation/MyFirstContribution.txt After a few days, you will hopefully receive a reply to your patchset with some · line 1155

Quoted 10 lines
Documentation/MyFirstContribution.txt +6 -0
+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.
 
+Reviewers may ask you about what you wrote in the patchset, either in
+the proposed commit log message or in the changes themselves.  You
+should answer these questions in your response messages, but often the
+reason why reviewers asked these questions to understand what you meant
+to write is because your patchset needed clarification to be understood.

Perhaps a paragraph break here?

Documentation/MyFirstContribution.txt After a few days, you will hopefully receive a reply to your patchset with some · line 1166

Quoted 11 lines
Documentation/MyFirstContribution.txt +8 -0
+Do not be satisfied by just answering their questions in your response
+and hear them say that they now understand what you wanted to say.
+Update your patches to clarify the points reviewers had trouble with,
+and prepare your v2; the words you used to explain your v1 to answer
+reviewers' questions may be useful thing to use.  Your goal is to make
+your v2 clear enough so that it becomes unnecessary for you to give the
+same explanation to the next person who reads it.
+
 If you are going to push back on a comment, be polite and explain why you feel
 your original is better; be prepared that the reviewer may still disagree with
 you, and the rest of the community may weigh in on one side or the other. As

Is this also worth mentioning in SubmittingPatches?

With or without the paragraph split

#2 lore raw
Quoted 1 line · Philip Oakley

Is this also worth mentioning in SubmittingPatches?

Yes, see what I wrote immediately under three-dash lines.

My wish is that, once we know the complete message we want to send with this longer document, we may see some volunteer to update SubmittingPatches with a more condensed version. ;-)

Thanks.

Reviewed-by
#3 lore raw
In reply to Philip Oakley
Quoted 7 lines · Philip Oakley
Quoted 7 lines

It's good manners to reply to each comment, notifying the reviewer that you have

Documentation/MyFirstContribution.txt +1 -1
-made the change requested, feel the original is better, or that the comment
+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.
Quoted 7 lines

Documentation/MyFirstContribution.txt After a few days, you will hopefully receive a reply to your patchset with some · line 1155

Quoted 5 lines
Documentation/MyFirstContribution.txt +5 -0
+Reviewers may ask you about what you wrote in the patchset, either in
+the proposed commit log message or in the changes themselves.  You
+should answer these questions in your response messages, but often the
+reason why reviewers asked these questions to understand what you meant
+to write is because your patchset needed clarification to be understood.

Perhaps a paragraph break here?

Agreed.

Quoted 7 lines

Documentation/MyFirstContribution.txt After a few days, you will hopefully receive a reply to your patchset with some · line 1162

Quoted 7 lines
Documentation/MyFirstContribution.txt +7 -0
+Do not be satisfied by just answering their questions in your response
+and hear them say that they now understand what you wanted to say.
+Update your patches to clarify the points reviewers had trouble with,
+and prepare your v2; the words you used to explain your v1 to answer
+reviewers' questions may be useful thing to use.  Your goal is to make
+your v2 clear enough so that it becomes unnecessary for you to give the
+same explanation to the next person who reads it.

Overall a point I really appreciate having written out here. I think it's a good addition to this doc.

#4 lore raw
Quoted 9 lines · Emily Shaffer
Quoted 3 lines
Quoted 1 line

+to write is because your patchset needed clarification to be understood.

Perhaps a paragraph break here?

Agreed.
...
Overall a point I really appreciate having written out here. I think it's a good addition to this doc.

Thanks.

#5 lore raw
In reply to Junio C Hamano

Hi Junio,

Quoted 18 lines · Junio C Hamano

A review exchange may begin with a reviewer asking "what did you mean by this phrase in your log message (or here in the doc)?", the author answering what was meant, and then the reviewer saying "ah, that is what you meant---then the flow of the logic makes sense".

But that is not the happy end of the story. New contributors often forget that the material that has been reviewed in the above exchange is still unclear in the same way to the next person who reads it, until it gets updated.

While we are in the vicinity, rephrase the verb "request" used to refer to comments by reviewers to "suggest"---this matches the contrast between "original" and "suggested" that appears later in the same paragraph, and more importantly makes it clearer that it is not like authors are to please reviewers' wishes but rather reviewers are merely helping authors to polish their commits.

Quoted 2 lines

---

I think this is a nice addition. However the patch title should probably be prefixed "MyFirstContribution" and not "myFirstContribition" ;)

Cheers!

Philippe.

#6 lore raw
Quoted 2 lines · Philippe Blain

I think this is a nice addition. However the patch title should probably be prefixed "MyFirstContribution" and not "myFirstContribition" ;)

Will update. Thanks.