I'm personally a fan of the issue number being the first thing on the subject line, like "OPENNLP-xxx: commit message." For me it gives a consistent place to look for the issue without having to read the full message. (That way you can also see the issue number in GitHub's commit list without having to expand the commit.)
On Mon, Jan 9, 2017 at 1:48 PM, Joern Kottmann <[email protected]> wrote: > It doesn't matter where the jira# is placed, as long as it is there. > > Can be in the first line or occur somewhere later in the message, > for example see OPENNLP-914. There it was placed in the body. > > Jörn > > On Mon, 2017-01-09 at 13:20 -0500, Suneel Marthi wrote: > > I guess the reason to include the jira# at the beginning of the > > message is > > because the same would be reflected in the corresponding jira (i > > could be > > wrong here). > > > > I am not sure if omitting the issue# in the git subject line would > > still > > reflect the git convo in jira or not. > > > > > > > > On Mon, Jan 9, 2017 at 8:26 AM, Joern Kottmann <[email protected]> > > wrote: > > > > > Hello all, > > > > > > we are using different styles for commit messages. It would be good > > > to have > > > a short discussion on how we think they should be and agree all on > > > how to > > > write the subject line. > > > > > > Here are few points from me: > > > - Good commit messages are important to understand what happened in > > > the > > > project and motivate to produce well thought through commits > > > - In git we have a subject line, first line in the commit message, > > > should > > > be around 50 chars, GH cuts after 72 chars and knows this > > > convention > > > - Subject line is usually written in imperative (git convention) > > > - Capitalize the first word (like in a new sentence) > > > - Commit message should contain the issue symbol > > > > > > Open questions: > > > - Should the issue symbol be in the subject line? Or in the body? > > > - Everyone fine with writing subject line in imperative? > > > > > > Here is an interesting article about it: > > > http://chris.beams.io/posts/git-commit/ > > > > > > Jörn > > > >
