The format is very similar to the one most other git shops I've worked in
before use.  I don't believe we ever had formal length limits.  Typically,
it was:

<JIRAPROJECT>-####: <Jira Ticket Summary>
>
blank line

<brief description of fix, usually matching what was placed in the ticket>


The Atlassian plugin for IDEA automates a lot of this.  There are limits on
the length of a jira ticket summary, but I'm not sure what that is.  I ran
in to it when I did my round of CI.

I don't see a reason to change anything except maybe stress that he lengths
are a guideline, not a hard & fast rule.  If more room is needed to write
good information, it shouldn't be truncated as it's not unknown to move
away from a given ticket system.

On Wed, Aug 17, 2016 at 3:38 PM, Kirk Lund <kl...@pivotal.io> wrote:

> 50 chars including "GEODE-nnnn: " is awfully short.
> http://chris.beams.io/posts/git-commit/ does say that's just a general
> rule
> of thumb and not a hard limit. The author's reasoning seems to be
> specifically for using "git log --oneline" -- does anyone use that option
> with git log? I don't.
>
> I guess another option is to not have to have a guideline if we don't want
> one... our current git log messages are reasonable and make sense.
>
> -Kirk
>
>
> On Wed, Aug 17, 2016 at 3:21 PM, Kirk Lund <kl...@pivotal.io> wrote:
>
> > Here's the git commit message guidelines we discussed and voted on last
> > year. I just checked and my own git commit message line lengths have
> grown
> > beyond what we decided to use. Most other are also not following this
> > guideline.
> >
> > Here's the list of folks who voted last year along with their vote:
> >
> > Anthony Baker +1
> > Vincent Ford +1
> > William Markito +1
> > arghya sadhu +1
> >
> > Do we want to reaffirm this guideline or should it change?
> >
> > -Kirk
> >
> > ---------- Forwarded message ----------
> > From: Kirk Lund <kl...@pivotal.io>
> > Date: Wed, Aug 5, 2015 at 3:18 PM
> > Subject: git commit messages
> > To: dev@geode.incubator.apache.org
> >
> >
> > Several of us were discussing http://chris.beams.io/posts/git-commit/ --
> > there are a couple other really good articles about git commit messages
> and
> > below is the message style I've been trying to follow.
> >
> > http://chris.beams.io/posts/git-commit/
> > http://www.laurencegellert.com/2013/07/how-to-write-a-proper-commit-
> > message/
> > http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
> >
> > GEODE-nn: Begin capitalized and 50 chars or less
> >
> > More detailed explanation with linefeeds to wrap at 72 characters after
> > a blank line following the summary.
> >
> > Further paragraphs come after blank lines.
> >
> > - Bullet points are okay, too
> >
> > - Typically a hyphen or asterisk is used for the bullet, followed by a
> >   single space, with blank lines in between, but conventions vary here
> >
> > - Use a hanging indent
> >
> >
> >
> >
>

Reply via email to