Sounds familiar :) I think I've said that once or twice :) Fully agree. On the same topic, we should avoid messages that describe the code you typed -- we can see that in the diff.
-- poor: "fixed a null pointer in the xyz method" -- good: "Applications without the Foo annotation fail to deploy" In this fictitious example, anyone can see that a null pointer check was added, but no one will know why unless the message says so. Rule of thumb: say something people can't easily learn by reading the diff. -- David Blevins http://twitter.com/dblevins http://www.tomitribe.com On May 16, 2014, at 8:31 AM, Romain Manni-Bucau <[email protected]> wrote: > Hi guys, > > a quick message to try to normalize a bit commit messages (I blame > nobody that's for me too ;) ). > > If working against a jira would be great to use (my proposal but can > be discussed): [JIRA NAME] [short description in english] > > For instance: > > "TOMEE-8888 change default value foo attribute in tomee.xml" > > Main goal is to avoid things like: > > "working on TOMEE-4568" or "https://issues.apache.org/jira/browse/TOMEE-8756"; > > This is hard to re-browse history without textual description > > > Romain Manni-Bucau > Twitter: @rmannibucau > Blog: http://rmannibucau.wordpress.com/ > LinkedIn: http://fr.linkedin.com/in/rmannibucau > Github: https://github.com/rmannibucau >
