Stop adding ending dot to commit subject line
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:/
- source of any major open source project, e.g. Linux kernel commits
- more at https:/
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!
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.