MyFirstContribition: answering questions is not the end of the story
authorJunio C Hamano <gitster@pobox.com>
Fri, 20 Nov 2020 17:52:26 +0000 (09:52 -0800)
committerJunio C Hamano <gitster@pobox.com>
Tue, 24 Nov 2020 22:11:17 +0000 (14:11 -0800)
commita6d8d1103633f295ce6f738dcd5221389e8d5fd2
treeae146da347dfcbba075a8da47d2701d0363ac89a
parent898f80736c75878acc02dc55672317fcc0e0a5a6
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.

Reviewed-by: Emily Shaffer <emilyshaffer@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/MyFirstContribution.txt