Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 16 Dec 2020 14:35:56 -0800
From:      John Baldwin <jhb@FreeBSD.org>
To:        Ed Maste <emaste@freebsd.org>, freebsd-git <freebsd-git@freebsd.org>
Subject:   Re: Git commit message templates
Message-ID:  <c18f71b2-8356-c1ad-b0d7-9b742f2d9fb9@FreeBSD.org>
In-Reply-To: <CAPyFy2DveYMw6VyxT8QwOCNreHTyi6RoYX1EWEfysMEqCpcjZQ@mail.gmail.com>
References:  <CAPyFy2DveYMw6VyxT8QwOCNreHTyi6RoYX1EWEfysMEqCpcjZQ@mail.gmail.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On 12/16/20 8:58 AM, Ed Maste wrote:
> I've written up an article on commit messages that's now incorporated
> into Warner's doc collection, with an intended final destination of
> the handbook. The current version of that document is here:
> https://github.com/bsdimp/freebsd-git-docs/blob/main/commit.md

The only one I'm not a fan of is the lack of punctuation for the first
sentence.  Newspaper headlines also use additional capitalization
(e.g. last word and "significant words"), so the current recommendation
is a mix of things and not fully consistent with either one.  Given
our previous practice to date in CVS and SVN, using a full sentence
and formatting it as a sentence seems more consistent.  I suspect in
practice though that trailing punctuation might just vary by committer.
(That seems to be what happens in some other projects I've looked
at.)

-- 
John Baldwin



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?c18f71b2-8356-c1ad-b0d7-9b742f2d9fb9>