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

Re: [PATCH v2 1/1] commit: display advice hints when commit fails

From
Emily Shaffer <emilyshaffer@google.com>
Date
Dec 20, 2019, 21:39 UTC
Message-ID
<20191220213926.GA1876@google.com>
In-Reply-To
<xmqqbls2alsb.fsf@gitster-ct.c.googlers.com>
On Fri, Dec 20, 2019 at 10:34:28AM -0800, Junio C Hamano wrote:
Show 8 quoted lines
> Emily Shaffer <emilyshaffer@google.com> writes:
> 
> > Hm. I'm surprised to see this feedback come in the form of a local
> > change when making the topic branch, rather than in a reply to the v1
> > patch. What's the reasoning? (Or is this scissors patch intended to be
> > the feedback?)
> 
> You haven't seen a suggestion in the form of counter-proposal?

I actually have only seen the scissors-patch as a "yes, and" in practice. I think this is a sign I should be doing more reviews ;)

Show 23 quoted lines
> 
> > I ask because out of all of us, it seems the Outreachy interns can
> > benefit the most from advice on how and why to write their commit
> > messages - that is, part of the point of an internship is to learn best
> > practices and cultural norms in addition to coding practice. (Plus, I
> > find being asked to rewrite a commit message tends to force me to
> > understand my own change even better than before.)
> 
> It's something Mentors can help doing (I do not necessarily have
> time for that myself), and you're welcome to use the "tenatively
> queued" version as an example.
> 
> > I'll go ahead and look through the changes to the commit message so I
> > can learn what you're looking for too :)
> 
> Nice.
> 
> One thing you missed in your review of the "tentatively queued"
> version is the reversal of the order of presentation.  Instead of
> starting with "I decided to do this" without explanation, give the
> picture of status quo to set the stage, explain what issue exists in
> the current behaviour, and then describe what approach was chosen to
> solve the issue.
Thanks for explaining this - that's a good point for me to take home.
Show 15 quoted lines
> 
> > For me, I don't particularly see why we'd want to be rid of it - it sort
> > of feels like "a picture is worth a thousand words" to include the
> > actual use case in the commit message.
> 
> Output coming from commands and/or options that are used only in a
> bit more advanced workflow and the ones that are rarely seen, I do
> agree that showing example is a good way to illustrate exactly what
> you are talking about.
> 
> On the other hand, for behaviour of basic local commands like "git
> add", "git commit", "git diff", ..., I do not necessarily agree, as
> these should be obvious and clear to all the intended audiences,
> which would be "anybody who has used Git for say more than two
> weeks.
Hm, I see. Thanks for clarifying.
 - Emily
Previous: Junio C HamanoNext: Jonathan Tan
Message 17 of 27 in “[Outreachy] commit: display advice hints when commit fails”
  1. 0/1 [Outreachy] commit: display advice hints when commit failsHeba Waly via GitGitGadget, Dec 17, 2019
  2. 1/1 commit: display advice hints when commit failsHeba Waly via GitGitGadget, Dec 17, 2019
  3. Junio C HamanoDec 17, 2019
  4. Emily ShafferDec 17, 2019
  5. Heba WalyDec 19, 2019
  6. Jonathan TanDec 18, 2019
  7. Junio C HamanoDec 18, 2019
  8. Heba WalyDec 19, 2019
  9. 0/1 [Outreachy] commit: display advice hints when commit failsHeba Waly via GitGitGadget, Dec 19, 2019
  10. 1/1 commit: display advice hints when commit failsHeba Waly via GitGitGadget, Dec 19, 2019
  11. Junio C HamanoDec 19, 2019
  12. Junio C HamanoDec 19, 2019
  13. Eric SunshineDec 19, 2019
  14. Junio C HamanoDec 19, 2019
  15. Emily ShafferDec 20, 2019
  16. Junio C HamanoDec 20, 2019
  17. Emily ShafferDec 20, 2019
  18. Jonathan TanDec 31, 2019
  19. Junio C HamanoDec 31, 2019
  20. Jonathan TanJan 2, 2020
  21. Junio C HamanoDec 19, 2019
  22. Emily ShafferDec 19, 2019
  23. Junio C HamanoDec 19, 2019
  24. Junio C HamanoDec 19, 2019
  25. Heba WalyDec 21, 2019
  26. Junio C HamanoDec 21, 2019
  27. Heba WalyDec 21, 2019

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.