Mailing-List: contact dev-help@asterixdb.incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@asterixdb.incubator.apache.org
From: Eldon Carman <ecarm002@ucr.edu>
Content-Type: text/plain;
	charset=us-ascii
Content-Transfer-Encoding: quoted-printable
Mime-Version: 1.0 (1.0)
Subject: Re: Commit message proposal
Message-Id: <17C634AE-0E60-4171-AEFA-1CE32BD458C2@ucr.edu>
Date: Thu, 17 Sep 2015 13:26:11 -0700
References: 
 <CAHWyyRzF5tdZnt9nLwzQsVAS77Xbk2bG1EduA7n_jWXVGTFHsg@mail.gmail.com>
In-Reply-To: 
 <CAHWyyRzF5tdZnt9nLwzQsVAS77Xbk2bG1EduA7n_jWXVGTFHsg@mail.gmail.com>
To: "dev@asterixdb.incubator.apache.org" <dev@asterixdb.incubator.apache.org>

I like the proposal. This will be helpful when got and Jira are linked.=20


Sent from my iPhone

> On Sep 17, 2015, at 1:14 PM, Chris Hillery <chillery@hillery.land> wrote:
>=20
> At Couchbase, we have a commit message standard which has proven useful.
> All git commit messages must start with a short one-line summary of no mor=
e
> than 60 characters or so. Then a blank line, followed by additional
> details, specifics, etc. all on lines of no more than 72 characters. If
> it's a simple enough change that the one-line summary is all you need,
> that's fine too.
>=20
> Additionally, if the commit is for a specific ticket, that ticket number
> must be at the beginning of the summary line, followed by a colon. FYI our=

> tickets in Jira are named eg. ASTERIXDB-1097. So, for example:
>=20
> ------
> ASTERIXDB-1097: Fix threading in printers
>=20
> Replace static data member with a safe thread-local instance to
> avoid data corruption.
> ------
>=20
> This really helps in tracking git history - there are several commands
> which will only display the first line of a commit message, for instance,
> so having it be self-contained makes it much easier to read. You may also
> have noticed that Gerrit uses that first line for the subjects of emails i=
t
> sends out. Also, by including the ticket name, we can easily configure
> Gerrit to provide a hyperlink to the ticket to make things easier to revie=
w.
>=20
> Here's a blog post which goes into excruciating detail about commit
> messages:
>=20
> http://chris.beams.io/posts/git-commit/
>=20
> Ceej
> aka Chris Hillery