From: John Feminella Date: 2011-06-13T20:58:04+09:00 Subject: Re: commit message conventions I greatly dislike that style, to be frank. My commit messages usually take this form: ===== [short, one-line description of what the commit achieves written in present tense] [metadata, typically referencing a ticket number] [skip a line here] [optional commit body to explain the commit in more detail or to describe new conventions introduced, considerations, etc.] ===== In other words, commits should read like they're e-mails: a short subject, followed by a blank line, followed by a body. Some examples of real commits I've made recently: ===== Adds new /api/transactions routes for managing transaction resources [finishes #1984] ===== Refactors DataLoader into smaller classes with more defined responsibilities ===== Deletes unneeded/deprecated references to LOAD_TIME constant Use of the LOAD_TIME constant was deprecated on April 15th in commit 2094ed1. It's now been a couple of months and we told clients that it would be officially discontinued on June 1, so it's safe to remove. ===== ~ jf -- John Feminella Principal Consultant, BitsBuilder LI: http://www.linkedin.com/in/johnxf SO: http://stackoverflow.com/users/75170/ On Mon, Jun 13, 2011 at 07:38, Intransition wrote: > When I write commit messages I add a "team" prefix to the message, > generally `admin`, 'doc` or `test` followed by a colon,  space, and > then message. e.g. > >    admin: Updated README to explain new config options > > That's worked well for me personally, as it allows me to sort commit > messages by category. But recently I've started to really give YARD a > shake for documenting my code, and I've toyed with the idea of > changing my commit messages to reflect YARD style: > >    @admin Updated README to explain new config options > > I'm not sure I like that as much though. > > Are there any known conventions for this sort of thing? Anyone else > have suggestions or personal conventions for commit messages that they > use? > >