Git commit message templates

Brooks Davis brooks at freebsd.org
Wed Dec 23 16:47:28 UTC 2020


On Mon, Dec 21, 2020 at 10:33:48AM -0700, Warner Losh wrote:
> On Mon, Dec 21, 2020 at 10:28 AM John Baldwin <jhb at freebsd.org> wrote:
> 
> > On 12/17/20 12:58 PM, Ed Maste wrote:
> > > On Wed, 16 Dec 2020 at 17:35, John Baldwin <jhb at freebsd.org> wrote:
> > >>
> > >> 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.
> > >
> > > Fair point - considering the first line as one would an email subject
> > > is probably the best approach.
> >
> > I agree.  Perhaps just say that (rather than newspaper headline) and leave
> > off the note about punctuation.
> >
> 
> Personally, I think we're starting to get a bit over prescriptive here.
> Once you have the length down, and have a keyword at the start, you've got
> 99% of the benefit. Nobody cares if there's a dot at the end or not, and
> it's presence or absence adds no value to other readers. Nobody cares about
> having lots of caps or not. We should just let people use their judgement.

While it makes little difference it seems reasonable to make a
suggestion here and for it to follow common conventions.  IMO there's
little value in un-opinionated style guides.  There might be something
to be said for flagging things that are more or less important.

-- Brooks
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 455 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-git/attachments/20201223/25df33e5/attachment.sig>


More information about the freebsd-git mailing list