Re: [PATCH v2] SubmittingPatches: release-notes entry experiment

From: Brian Lyles <brianmlyles@gmail.com>
Date: Mar 25, 2024, 23:37 UTC
Message-ID: <17c0263586f87125.70b1dd9aae081c6e.203dcd72f6563036@zivdesk>
In-Reply-To: <xmqq8r26eyva.fsf@gitster.g>

Hi Junio

On Mon, Mar 25, 2024 at 5:21 PM Junio C Hamano <gitster@pobox.com> wrote:

Show 11 quoted lines

> +[[a-paragraph-summary]]
> +
> +*This is EXPERIMENTAL*.  When sending a topic, you can propose one
> +paragraph summary that appears in the "What's cooking" report when it
> +is picked up to explain the topic.  If you choose to do so, please
> +write 2-5 lines of a paragraph that will fit well in our release notes
> +(see Documentation/RelNotes/* directory for examples), and make it
> +the first paragraph of the cover letter.  For a single-patch series,
> +use the space between the three-dash line and the diffstat, as
> +described earlier.
> +

One very minor grammar note: "you can propose *a* one paragraph summary".

Otherwise, this patch looks good to me. Thanks for considering this.

-- 
Thank you,
Brian Lyles