From: Emily Shaffer <emilyshaffer@google.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Heba Waly via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org, Heba Waly <heba.waly@gmail.com>
Subject: Re: [PATCH v2 1/1] commit: display advice hints when commit fails
Date: Fri, 20 Dec 2019 13:39:26 -0800 [thread overview]
Message-ID: <20191220213926.GA1876@google.com> (raw)
In-Reply-To: <xmqqbls2alsb.fsf@gitster-ct.c.googlers.com>
On Fri, Dec 20, 2019 at 10:34:28AM -0800, Junio C Hamano wrote:
> 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 ;)
>
> > 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.
>
> > 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
next prev parent reply other threads:[~2019-12-20 21:39 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-17 9:17 [PATCH 0/1] [Outreachy] commit: display advice hints when commit fails Heba Waly via GitGitGadget
2019-12-17 9:17 ` [PATCH 1/1] " Heba Waly via GitGitGadget
2019-12-17 22:41 ` Junio C Hamano
2019-12-17 22:45 ` Emily Shaffer
2019-12-19 3:47 ` Heba Waly
2019-12-18 3:13 ` Jonathan Tan
2019-12-18 18:14 ` Junio C Hamano
2019-12-19 3:48 ` Heba Waly
2019-12-19 9:16 ` [PATCH v2 0/1] [Outreachy] " Heba Waly via GitGitGadget
2019-12-19 9:16 ` [PATCH v2 1/1] " Heba Waly via GitGitGadget
2019-12-19 19:14 ` Junio C Hamano
2019-12-19 19:22 ` Junio C Hamano
2019-12-19 19:47 ` Eric Sunshine
2019-12-19 19:57 ` Junio C Hamano
2019-12-20 2:31 ` Emily Shaffer
2019-12-20 18:34 ` Junio C Hamano
2019-12-20 21:39 ` Emily Shaffer [this message]
2019-12-31 0:04 ` Jonathan Tan
2019-12-31 19:06 ` Junio C Hamano
2020-01-02 19:56 ` Jonathan Tan
2019-12-19 18:26 ` [PATCH v2 0/1] [Outreachy] " Junio C Hamano
2019-12-19 18:54 ` Emily Shaffer
2019-12-19 19:23 ` Junio C Hamano
2019-12-19 19:45 ` Junio C Hamano
2019-12-21 4:37 ` Heba Waly
2019-12-21 23:54 ` Junio C Hamano
2019-12-21 5:02 ` Heba Waly
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=20191220213926.GA1876@google.com \
--to=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=heba.waly@gmail.com \
/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).