git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Benji Fisher <benji@FisherFam.org>
Cc: git@vger.kernel.org,  nasamuffin@google.com
Subject: Re: [PATCH] MyFirstContribution: use switch for changing branches
Date: Mon, 08 Apr 2024 10:42:33 -0700	[thread overview]
Message-ID: <xmqqr0ffbvjq.fsf@gitster.g> (raw)
In-Reply-To: <20240407212109.35131-1-benji@FisherFam.org> (Benji Fisher's message of "Sun, 7 Apr 2024 17:21:09 -0400")

Benji Fisher <benji@FisherFam.org> writes:

> Use "git switch" instead of "git checkout" for changing branches.

... because?

In the proposed log message, make sure you are telling the readers
WHY the change was needed and desirable.

The usual way to compose a log message for this project is to

 - Give an observation on how the current system work in the present
   tense (so no need to say "Currently X is Y", just "X is Y"), and
   discuss what you perceive as a problem in it.

 - Propose a solution (optional---often, problem description
   trivially leads to an obvious solution in reader's minds).

 - Give commands to the codebase to "become like so".

in this order.

For this particular patch, I do not see a compelling reason why we
should make these changes.  It is not like MyFirst* documents
consistently uses "git switch" (and "git restore") in other places
and these three are the exceptions (in which case that would be a
very good justification you would describe in the "observation"
paragraph of your proposed log message).  We are not deprecating
"git checkout", either.

Thanks.


  reply	other threads:[~2024-04-08 17:42 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-07 21:21 [PATCH] MyFirstContribution: use switch for changing branches Benji Fisher
2024-04-08 17:42 ` Junio C Hamano [this message]
2024-04-09 12:26   ` Benji Fisher
2024-04-09 13:47     ` Kipras Melnikovas
2024-04-09 16:11     ` [PATCH] MyFirstContribution: use switch for changing branches Junio C Hamano
2024-04-09 16:36       ` Emily Shaffer

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=xmqqr0ffbvjq.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=benji@FisherFam.org \
    --cc=git@vger.kernel.org \
    --cc=nasamuffin@google.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).