Mailing-List: contact dev-help@opennlp.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@opennlp.apache.org
From: ARUN Thundyill Saseendran <ats0stv@gmail.com>
Content-Type: text/plain;
	charset=utf-8
Content-Transfer-Encoding: quoted-printable
Mime-Version: 1.0 (1.0)
Date: Wed, 11 Jan 2017 06:01:47 +0530
Subject: Re: Commit message style
Message-Id: <A2FB7450-D320-4106-B103-F0773F4DEDC5@gmail.com>
References: <CA+V=Wqi1FrS+=oGh0mFY1f3ghxq_u9cYDHT9s8LQwO27YrEQZg@mail.gmail.com> <CAOtpBjh57qe=dHdhbkqhjD32RaYfT0_fKBR030QftvPMmXr0SA@mail.gmail.com> <1483987689.4245.1.camel@gmail.com> <CAHrL1JZF8UaJfECUC0tyE5YfJQkc9w+in-QNnJAzXG+CAWO6zg@mail.gmail.com> <1484004263.4245.11.camel@gmail.com> <CA+iWThKDmA4+LO-zaztJ+JJ9fpZwpK334f1N2uPmurzRZAz=+Q@mail.gmail.com> <CAKvDkVBVijXKoA3RqGgHhTu1suxDjs6iKeWbVU7oAvj1PRF6yg@mail.gmail.com> <CAGnSx05B5QdgMr=OnPpOnP-WYOL7Z+BwiwbBCLy4uMSsL-=S5w@mail.gmail.com> <CAMYzrwrQJA0VAVCjfC2hcexeq_91P8cE=vD8363nXKyK8Tp7JA@mail.gmail.com> <1484083147.2251.8.camel@gmail.com> <CAOtpBjhvH=u4_7GhQ0FLqZ8CfFhw0HsLFHFRKqQm7Q4NWFx-fA@mail.gmail.com>
In-Reply-To: <CAOtpBjhvH=u4_7GhQ0FLqZ8CfFhw0HsLFHFRKqQm7Q4NWFx-fA@mail.gmail.com>
To: dev@opennlp.apache.org
archived-at: Wed, 11 Jan 2017 00:32:01 -0000

True a template for PRs will be very helpful.

Also a shared validation trigger for commit messages will help reduce manual=
 effort in verifying commit messages.

Also mandating JIRA Issue keys in commit messages will help us easily correl=
ate a feature, requirement, bug etc., with the associated code commits.

Thanks
Arun

> On 11-Jan-2017, at 2:51 AM, Suneel Marthi <suneel.marthi@gmail.com> wrote:=

>=20
> Other projects like flink, spark etc... have a template u would need to
> fill out before a PR can be made. This is a github based template which we=

> could create one for OpenNLP too.
>=20
>=20
>=20
>> On Tue, Jan 10, 2017 at 4:19 PM, Joern Kottmann <kottmann@gmail.com> wrot=
e:
>>=20
>> Should we have a shared hook script that can be used for commit message
>> validation?
>>=20
>> Are there other things we would like to do with that?
>>=20
>> Currently we can easily catch bad commit messages during review,
>> commits usually get squashed into one to not have all the feedback
>> commits in our history.
>>=20
>> J=C3=B6rn
>>=20
>>> On Wed, 2017-01-11 at 02:14 +0530, ARUN Thundyill Saseendran wrote:
>>> +1
>>>=20
>>> Just to confirm,
>>>=20
>>> *OPENNLP-xxx[,OPENNLP-yyy,...] : Commit Message*
>>>=20
>>> Also will there be a pre-commit trigger in git to validate this.
>>>=20
>>> Thanks
>>> Arun
>>>=20
>>> On Wed, Jan 11, 2017 at 2:08 AM, Tommaso Teofili <tommaso.teofili@gma
>>> il.com>
>>> wrote:
>>>=20
>>>> +1
>>>>=20
>>>> Tommaso
>>>>=20
>>>> Il giorno mar 10 gen 2017 alle ore 11:20 Rodrigo Agerri <
>>>> ragerri@apache.org>
>>>> ha scritto:
>>>>=20
>>>>> +1 for the OPENNLP-xxx: commit message.
>>>>>=20
>>>>>=20
>>>>>=20
>>>>> On Tue, Jan 10, 2017 at 12:51 AM, William Colen <william.colen@gm
>>>>> ail.com
>>>>>=20
>>>>> wrote:
>>>>>=20
>>>>>> +1 for the OPENNLP-xxx: commit message.
>>>>>> Fast to find a commit.
>>>>>>=20
>>>>>>=20
>>>>>> 2017-01-09 21:24 GMT-02:00 Joern Kottmann <kottmann@gmail.com>:
>>>>>>=20
>>>>>>> On Mon, 2017-01-09 at 17:02 -0500 <02%200500>, Jeffrey
>>>>>>> Zemerick
>>>>=20
>>>> wrote:
>>>>>>>> I'm personally a fan of the issue number being the first
>>>>>>>> thing on
>>>>=20
>>>> 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.)
>>>>>>>=20
>>>>>>>=20
>>>>>>> Yes, it is also faster to write like that, on the other hand
>>>>>>> if the
>>>>>>> subject line is then too short to write something meaningful
>>>>>>> it is
>>>>>>> probably better to write it in the body instead.
>>>>>>>=20
>>>>>>> +1 to write it first thing in the subject line in all cases
>>>>>>> where it
>>>>=20
>>>> is
>>>>>>> possible, for very rare cases where it doesn't work it can
>>>>>>> still be
>>>>=20
>>>> in
>>>>>>> the body
>>>>>>>=20
>>>>>>> J=C3=B6rn
>>>>>>>=20
>>>=20
>>>=20
>>>=20
>>> --
>>=20