git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] myFirstContribition: answering questions is not the end of the story

From
Emily Shaffer <emilyshaffer@google.com>
Date
Nov 24, 2020, 20:14 UTC
Message-ID
<20201124201419.GA3783238@google.com>
In-Reply-To
<33e4b940-2560-83b7-1015-100c16c71345@iee.email>
On Fri, Nov 20, 2020 at 09:42:16PM +0000, Philip Oakley wrote:
Show 14 quoted lines
> >  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.
Show 7 quoted lines
> > +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>
Previous: Junio C HamanoNext: Junio C Hamano
Message 4 of 7 in “myFirstContribition: answering questions is not the end of the story”
  1. myFirstContribition: answering questions is not the end of the storyJunio C Hamano, Nov 20, 2020
  2. Philip OakleyNov 20, 2020
  3. Junio C HamanoNov 20, 2020
  4. Emily ShafferNov 24, 2020
  5. Junio C HamanoDec 1, 2020
  6. Philippe BlainNov 21, 2020
  7. Junio C HamanoNov 21, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.