From: Eric Sunshine <sunshine@sunshineco.com>
Date: Thu, 27 Jan 2022 07:31:34 GMT
Subject: Re: [PATCH v2 2/3] CodingGuidelines: hint why we value clearly written log messages
Message-ID: <CAPig+cRNwjaRtqLcGrz-oE+C+atAHiRgXTDTUTisgDabkOvcMw@mail.gmail.com>
In-Reply-To: <20220126234205.2923388-3-gitster@pobox.com>

On Thu, Jan 27, 2022 at 1:32 AM Junio C Hamano <gitster@pobox.com> wrote:
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> @@ -26,6 +26,13 @@ code.  For Git in general, a few rough rules are:
> + - Log messages to explain your changes are as much important as the

Nit: Dropping "much" makes this sound a bit better grammatically:

"Log messages which explain your changes are as important as the..."

> +   changes themselves.  Clearly written code and in-code comments
> +   explain how the code works and what is assumed from the surrounding
> +   context.  The log messages explain what the changes wanted to
> +   achieve and why the changes were necessary (more on this in the
> +   accompanying SubmittingPatches document).