From: Emily Shaffer <emilyshaffer@google.com>
To: Philip Oakley <philipoakley@iee.email>
Cc: Junio C Hamano <gitster@pobox.com>, git@vger.kernel.org
Subject: Re: [PATCH] myFirstContribition: answering questions is not the end of the story
Date: Tue, 24 Nov 2020 12:14:19 -0800 [thread overview]
Message-ID: <20201124201419.GA3783238@google.com> (raw)
In-Reply-To: <33e4b940-2560-83b7-1015-100c16c71345@iee.email>
On Fri, Nov 20, 2020 at 09:42:16PM +0000, Philip Oakley wrote:
> > 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.
>
> Perhaps a paragraph break here?
Agreed.
> > +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.
Reviewed-by: Emily Shaffer <emilyshaffer@google.com>
next prev parent reply other threads:[~2020-11-24 20:19 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-20 17:52 [PATCH] myFirstContribition: answering questions is not the end of the story Junio C Hamano
2020-11-20 21:42 ` Philip Oakley
2020-11-20 22:34 ` Junio C Hamano
2020-11-24 20:14 ` Emily Shaffer [this message]
2020-12-01 4:46 ` Junio C Hamano
2020-11-21 2:54 ` Philippe Blain
2020-11-21 21:53 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201124201419.GA3783238@google.com \
--to=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=philipoakley@iee.email \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).