From: Junio C Hamano <gitster@pobox.com>
Date: Fri, 04 Mar 2022 00:29:49 GMT
Subject: Re: [PATCH v3 3/3] SubmittingPatches: explain why we care about log messages
Message-ID: <xmqqr17i5zlu.fsf@gitster.g>
In-Reply-To: <YiFY693P6E/eVS3k@google.com>

Emily Shaffer <emilyshaffer@google.com> writes:

>> +The goal of your log message is to convey the _why_ behind your
>> +change to help future developers.
>> +
>
> This is pretty compelling. Is it clear enough why we care about this in
> the commit message, as opposed to in the patch description (cover letter
> or post-"---" blurb)? Is it too obvious to explicitly mention that the
> commit message is the first thing we try to make sense of during a 'git
> blame' or 'git bisect'?

Having to say "this may be better in the in-code comment rather than
the log message" to some patch recently (I do not remember), I tend
to agree that some guidance would help people decide between the two
(or writing both).

Again, patches welcome ;-)