Git commit message templates

John Baldwin jhb at FreeBSD.org
Wed Dec 16 22:35:58 UTC 2020


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


More information about the freebsd-git mailing list