Stop adding ending dot to commit subject line

Bug #1927842 reported by Otto Kekäläinen
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Breezy
Opinion
Undecided
Unassigned

Bug Description

The Breezy library is cool and in general it is very nice to see that people work on this aspect of software quality increasing tools.

I've noticed however one annoying mistake that is present in the Breezy commit logs itself and apparently built-in in how Breezy makes commit messages. The commit summary line seems to always end with a dot, while it shoudn't.

See e.g.
- https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#_commit_guidelines
- source of any major open source project, e.g. Linux kernel commits
- more at https://github.com/Seravo/gnitpick#recommended-reads

Golden commit example:

    Capitalized, short (50 chars or less) summary

    More detailed explanatory text, if necessary. Wrap it to about 72
    characters or so. In some contexts, the first line is treated as the
    subject of an email and the rest of the text as the body. The blank
    line separating the summary from the body is critical (unless you omit
    the body entirely); tools like rebase will confuse you if you run the
    two together.

Note, no trailing dot in the subject line! The reason is the same as why email subject lines don't have trailing dots.

Thanks for considering this best practice to be adopted in Breezy!

Revision history for this message
Jelmer Vernooij (jelmer) wrote :

It's up to users of Breezy to add ending dots to Git commit messages - same as it is for Git itself. Users are just presented with a free-form file in vim to edit the entire commit message when they use interactive mode and otherwise they specify the entire commit message - there is no further manipulation by Breezy.

Revision history for this message
Jelmer Vernooij (jelmer) wrote :

You could argue that we should do strict enforcement and not allow any commit messages with a trailing dot on the first line, but I don't really want to do that unless C Git does.

Changed in brz:
status: New → Opinion
Revision history for this message
Otto Kekäläinen (otto) wrote :

True, git itself does not have any kind of built-in commit title or body checking, it is all free form. Thanks for letting me know that Breezy does not either and current trailing dots are all of manual origin.

The spirit of Breezy is to
> encourages a large number of development best practices
(https://github.com/breezy-team/breezy)

Thus I would continue to argue that this might be a beneficial idea?

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.