Proposal for a more unified commit message format

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
41 messages Options
123
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Michael Brohl-3
Thanks for your suggestions, Jacopo!

Leaner and cleaner, +1

So I think we can go with this as the new commit message format, if
noone has other suggestions?

Thanks,

Michael


Am 08.09.16 um 11:16 schrieb Jacopo Cappellato:

> What about the following slightly modified template?
>
> ======================
> [Implemented|Improved|Fix for|Documentation]: [Jira title|Free text]
> [(OFBIZ-xxxx)]
>
> [More detailed explanation of what has been done and what the fix achieves,
> sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
> ======================
>
> This is the list of the minor differences/comments:
> 1) Removed "Applied ...": in my opinion the Thanks (for the patch) part
> will cover this and they are redundant; in the thanks part we can mention
> if the patch has been included with modifications (crediting also the
> author of the modifications)
> 2) [Jira title] if it makes sense, otherwise use free text
> 3) use a blank line rather than "Details:": it is more natural and should
> still be easy for you to split the two parts
>
> Jacopo
>


smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Jacques Le Roux
Administrator
In reply to this post by Jacopo Cappellato-5
Le 08/09/2016 à 11:16, Jacopo Cappellato a écrit :

> What about the following slightly modified template?
>
> ======================
> [Implemented|Improved|Fix for|Documentation]: [Jira title|Free text]
> [(OFBIZ-xxxx)]
>
> [More detailed explanation of what has been done and what the fix achieves,
> sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
> ======================
>
> This is the list of the minor differences/comments:
> 1) Removed "Applied ...": in my opinion the Thanks (for the patch) part
> will cover this and they are redundant; in the thanks part we can mention
> if the patch has been included with modifications (crediting also the
> author of the modifications)
> 2) [Jira title] if it makes sense, otherwise use free text
> 3) use a blank line rather than "Details:": it is more natural and should
> still be easy for you to split the two parts
>
> Jacopo
>

I think it's a good idea to normalize our commits comments and your proposition seems good to me Jacopo.

Now, of course I wonder about how to automate it. I can do it on my own side using TortoiseSVN and Eclipse specific features, nice. I guess the same
exist on other svn GUI clients. But could we not enforce the rule and make things automated for committers? Here is an "official" answer from the
Subversion team https://subversion.open.collab.net/ds/viewMessage.do?dsMessageId=487681&dsForumId=4 So maybe we could use that as a basis to create
our own? https://gist.github.com/alecthegeek/4134951

Last but not least: this started from Michael's need to format monthly Jira notes in our blog (kudos for the work Michael!). It will certainly be
easier for Michael to have this in place. But you might have noticed that I asked a question to Atlassian about Jira which would remove the need for
for Michael, or any of us, to do this work by hand. I got no feedback from anyone, so I rather created a similar feature request:
https://jira.atlassian.com/browse/JSW-14843. I invite everyone to vote for it and add comments if necessary, thanks!

Jacques

Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Michael Brohl-3
Hi Jacques,

please see my remarks inline.

Am 09.09.16 um 06:40 schrieb Jacques Le Roux:

> I think it's a good idea to normalize our commits comments and your
> proposition seems good to me Jacopo.
>
> Now, of course I wonder about how to automate it. I can do it on my
> own side using TortoiseSVN and Eclipse specific features, nice. I
> guess the same exist on other svn GUI clients. But could we not
> enforce the rule and make things automated for committers? Here is an
> "official" answer from the Subversion team
> https://subversion.open.collab.net/ds/viewMessage.do?dsMessageId=487681&dsForumId=4 
> So maybe we could use that as a basis to create our own?
> https://gist.github.com/alecthegeek/4134951
I'm not sure if we should put too much effort in this. How do the
committers automate their commit messages today? I guess most do it
either by hand every time, have some snippets they reuse or some kind of
software which offers shortcuts /clipboard features. I would leave it
like that.
>
> Last but not least: this started from Michael's need to format monthly
> Jira notes in our blog (kudos for the work Michael!). It will
> certainly be easier for Michael to have this in place. But you might
> have noticed that I asked a question to Atlassian about Jira which
> would remove the need for for Michael, or any of us, to do this work
> by hand. I got no feedback from anyone, so I rather created a similar
> feature request: https://jira.atlassian.com/browse/JSW-14843. I invite
> everyone to vote for it and add comments if necessary, thanks!
Yes, the starting point was the work with the blog but I also see some
benefit for the commit messages and readability apart from that. The
Jira feature, even if it would allow filtering by date, would not
suffice my needs for the blog because they don't show the details. As a
source, I would always use our svn log.

Generating the links for the OFBIZ-xxxx is the easiest part, I have
automated this using Textwrangler regex search/replace.

So the new format would be helpful in any case.

Regards,

Michael


smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Michael Brohl-3
Hi everyone,

so does everyone agree with the following commit message template to use:


======================
[Implemented|Improved|Fix for|Documentation]: [Jira title|Free text]
[(OFBIZ-xxxx)]

[More detailed explanation of what has been done and what the fix achieves,
sideeffects etc.]

[Thanks:] [xxxx for ... and yyyy for]
======================


It would be very helpful to make this a general rule for the commit
messages, especially starting this month when we have our Community Day
(many changes expected, which is good! :-))

I've made my last commit using it and also saw that Jacopo (partly ;-) )
applied this in his latest commits.

Thanks,

Michael




smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Jacopo Cappellato-5
On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]>
wrote:

> ...
> I've made my last commit using it and also saw that Jacopo (partly ;-) )
> applied this in his latest commits.
>

I have applied the new template to one commit and then I have forgotten to
apply it to the second one and I was hoping you didn't notice it :-)
I have fixed the commit log now!

Jacopo



>
> Thanks,
>
> Michael
>
>
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Michael Brohl-3
Thanks, Jacopo :-)

Do you think we can apply the template as a general rule?

I will put it in the Wiki then and ask Committers to do their future
commits in this way in case they have not followed this discussions or
simply forgot. Maybe it will take some time to get used to it.

Thanks,

Michael


Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:

> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]>
> wrote:
>
>> ...
>> I've made my last commit using it and also saw that Jacopo (partly ;-) )
>> applied this in his latest commits.
>>
> I have applied the new template to one commit and then I have forgotten to
> apply it to the second one and I was hoping you didn't notice it :-)
> I have fixed the commit log now!
>
> Jacopo
>
>
>
>> Thanks,
>>
>> Michael
>>
>>
>>
>>


smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Nicolas Malin-2

Le 10/09/2016 à 10:05, Michael Brohl a écrit :
> Thanks, Jacopo :-)
>
> Do you think we can apply the template as a general rule?
>
> I will put it in the Wiki then and ask Committers to do their future
> commits in this way in case they have not followed this discussions or
> simply forgot. Maybe it will take some time to get used to it.
>
> Thanks,
Completely agree. Thanks Michael for this initiative, and I'm sure we
will need to alert (a fairly cordial manner) at the beginning each
commit that don't respect this rule. And myself first !

Nicolas
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Pierre Smits
In reply to this post by Michael Brohl-3
A rule - in general - implies, that, when not adhered to, there will be
consequences. What will those consequences be?
Will the rule police then bitch at the contributor in the same manor as a
few did, when they felt the need to lecture me about how I prioritise my
itch?

Food for thought.

Best regards,

Pierre Smits

ORRTIZ.COM <http://www.orrtiz.com>
OFBiz based solutions & services

OFBiz Extensions Marketplace
http://oem.ofbizci.net/oci-2/

On Sat, Sep 10, 2016 at 10:05 AM, Michael Brohl <[hidden email]>
wrote:

> Thanks, Jacopo :-)
>
> Do you think we can apply the template as a general rule?
>
> I will put it in the Wiki then and ask Committers to do their future
> commits in this way in case they have not followed this discussions or
> simply forgot. Maybe it will take some time to get used to it.
>
> Thanks,
>
> Michael
>
>
> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
>
> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]>
>> wrote:
>>
>> ...
>>> I've made my last commit using it and also saw that Jacopo (partly ;-) )
>>> applied this in his latest commits.
>>>
>>> I have applied the new template to one commit and then I have forgotten
>> to
>> apply it to the second one and I was hoping you didn't notice it :-)
>> I have fixed the commit log now!
>>
>> Jacopo
>>
>>
>>
>> Thanks,
>>>
>>> Michael
>>>
>>>
>>>
>>>
>>>
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

taher
Aside from the negative tone, I would say that we have a friendly community
and harmonious and enthusiastic committers. So usually when we set rules it
is more like general guidelines to help us become efficient and productive.
We adhere to these rules out of respect and appreciation to each other, not
because of fear of consequences.

Taher Alkhateeb

On Sep 10, 2016 12:19 PM, "Pierre Smits" <[hidden email]> wrote:

> A rule - in general - implies, that, when not adhered to, there will be
> consequences. What will those consequences be?
> Will the rule police then bitch at the contributor in the same manor as a
> few did, when they felt the need to lecture me about how I prioritise my
> itch?
>
> Food for thought.
>
> Best regards,
>
> Pierre Smits
>
> ORRTIZ.COM <http://www.orrtiz.com>
> OFBiz based solutions & services
>
> OFBiz Extensions Marketplace
> http://oem.ofbizci.net/oci-2/
>
> On Sat, Sep 10, 2016 at 10:05 AM, Michael Brohl <[hidden email]>
> wrote:
>
> > Thanks, Jacopo :-)
> >
> > Do you think we can apply the template as a general rule?
> >
> > I will put it in the Wiki then and ask Committers to do their future
> > commits in this way in case they have not followed this discussions or
> > simply forgot. Maybe it will take some time to get used to it.
> >
> > Thanks,
> >
> > Michael
> >
> >
> > Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
> >
> > On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]>
> >> wrote:
> >>
> >> ...
> >>> I've made my last commit using it and also saw that Jacopo (partly ;-)
> )
> >>> applied this in his latest commits.
> >>>
> >>> I have applied the new template to one commit and then I have forgotten
> >> to
> >> apply it to the second one and I was hoping you didn't notice it :-)
> >> I have fixed the commit log now!
> >>
> >> Jacopo
> >>
> >>
> >>
> >> Thanks,
> >>>
> >>> Michael
> >>>
> >>>
> >>>
> >>>
> >>>
> >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Jacques Le Roux
Administrator
I totally agree with you Taher!

Just allow me a small amendment inline :)

Le 10/09/2016 à 12:35, Taher Alkhateeb a écrit :
> We adhere to these rules out of respect and appreciation to each other, not
> because of fear of consequences.

We *NORMALLY* adhere to these rules out of respect and appreciation to each other, not because of fear of consequences.

There are (rare) cases where you need to be OFBiz police, notably with brands and domains.
I did that in the past and I will continue...

To be complete, I must says these case don't refer to OFBiz specific rules/policies/etc. but to the ASF guidelines notably http://www.apache.org/foundation/marks/domains and globally http://www.apache.org/foundation/marks/resources

Most of the time people don't clearly know about these "details" and act on good faith. Simply asking them to follow the guidelines is enough.

I think it was a good occasion to expose/remind these ASF rules/policies
   
Jacques

> Taher Alkhateeb
>
> On Sep 10, 2016 12:19 PM, "Pierre Smits" <[hidden email]> wrote:
>
>> A rule - in general - implies, that, when not adhered to, there will be
>> consequences. What will those consequences be?
>> Will the rule police then bitch at the contributor in the same manor as a
>> few did, when they felt the need to lecture me about how I prioritise my
>> itch?
>>
>> Food for thought.
>>
>> Best regards,
>>
>> Pierre Smits
>>
>> ORRTIZ.COM <http://www.orrtiz.com>
>> OFBiz based solutions & services
>>
>> OFBiz Extensions Marketplace
>> http://oem.ofbizci.net/oci-2/
>>
>> On Sat, Sep 10, 2016 at 10:05 AM, Michael Brohl <[hidden email]>
>> wrote:
>>
>>> Thanks, Jacopo :-)
>>>
>>> Do you think we can apply the template as a general rule?
>>>
>>> I will put it in the Wiki then and ask Committers to do their future
>>> commits in this way in case they have not followed this discussions or
>>> simply forgot. Maybe it will take some time to get used to it.
>>>
>>> Thanks,
>>>
>>> Michael
>>>
>>>
>>> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
>>>
>>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]>
>>>> wrote:
>>>>
>>>> ...
>>>>> I've made my last commit using it and also saw that Jacopo (partly ;-)
>> )
>>>>> applied this in his latest commits.
>>>>>
>>>>> I have applied the new template to one commit and then I have forgotten
>>>> to
>>>> apply it to the second one and I was hoping you didn't notice it :-)
>>>> I have fixed the commit log now!
>>>>
>>>> Jacopo
>>>>
>>>>
>>>>
>>>> Thanks,
>>>>> Michael
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>

Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Pierre Smits
In reply to this post by Michael Brohl-3
I wonder where the respect for the volunteer (spending his precious time,
scratching his itch, improving the product) is, when several PMC members
felt the need to roll over each other *telling* that contributor to follow
the *rules. *Especially when these rules are not rules, but rather
advice/suggestions that *can* be followed.

Complaining about a suggestion not followed, especially multiple times, is
clearly a sign of lack of appreciation of the contribution or respect for
the contributor. It is neither improving efficiency*,* but rather
counter-productive.

And what is as bad, is the fact that the persons complaining don't adhere
to their own advice. In stead of addressing their own actions *first* and
addressing unassigned issues *secondly*, they thought they would score
points when they singled out 1 contributor.

That borders on harassment. To put it mildly.

Pierre Smits

ORRTIZ.COM <http://www.orrtiz.com>
OFBiz based solutions & services

OFBiz Extensions Marketplace
http://oem.ofbizci.net/oci-2/

On Sat, Sep 10, 2016 at 12:56 PM, Jacques Le Roux <
[hidden email]> wrote:

> I totally agree with you Taher!
>
> Just allow me a small amendment inline :)
>
> Le 10/09/2016 à 12:35, Taher Alkhateeb a écrit :
>
>> We adhere to these rules out of respect and appreciation to each other,
>> not
>> because of fear of consequences.
>>
>
> We *NORMALLY* adhere to these rules out of respect and appreciation to
> each other, not because of fear of consequences.
>
> There are (rare) cases where you need to be OFBiz police, notably with
> brands and domains.
> I did that in the past and I will continue...
>
> To be complete, I must says these case don't refer to OFBiz specific
> rules/policies/etc. but to the ASF guidelines notably
> http://www.apache.org/foundation/marks/domains and globally
> http://www.apache.org/foundation/marks/resources
>
> Most of the time people don't clearly know about these "details" and act
> on good faith. Simply asking them to follow the guidelines is enough.
>
> I think it was a good occasion to expose/remind these ASF rules/policies
>   Jacques
>
>
> Taher Alkhateeb
>>
>> On Sep 10, 2016 12:19 PM, "Pierre Smits" <[hidden email]> wrote:
>>
>> A rule - in general - implies, that, when not adhered to, there will be
>>> consequences. What will those consequences be?
>>> Will the rule police then bitch at the contributor in the same manor as a
>>> few did, when they felt the need to lecture me about how I prioritise my
>>> itch?
>>>
>>> Food for thought.
>>>
>>> Best regards,
>>>
>>> Pierre Smits
>>>
>>> ORRTIZ.COM <http://www.orrtiz.com>
>>> OFBiz based solutions & services
>>>
>>> OFBiz Extensions Marketplace
>>> http://oem.ofbizci.net/oci-2/
>>>
>>> On Sat, Sep 10, 2016 at 10:05 AM, Michael Brohl <
>>> [hidden email]>
>>> wrote:
>>>
>>> Thanks, Jacopo :-)
>>>>
>>>> Do you think we can apply the template as a general rule?
>>>>
>>>> I will put it in the Wiki then and ask Committers to do their future
>>>> commits in this way in case they have not followed this discussions or
>>>> simply forgot. Maybe it will take some time to get used to it.
>>>>
>>>> Thanks,
>>>>
>>>> Michael
>>>>
>>>>
>>>> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
>>>>
>>>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]
>>>> >
>>>>
>>>>> wrote:
>>>>>
>>>>> ...
>>>>>
>>>>>> I've made my last commit using it and also saw that Jacopo (partly ;-)
>>>>>>
>>>>> )
>>>
>>>> applied this in his latest commits.
>>>>>>
>>>>>> I have applied the new template to one commit and then I have
>>>>>> forgotten
>>>>>>
>>>>> to
>>>>> apply it to the second one and I was hoping you didn't notice it :-)
>>>>> I have fixed the commit log now!
>>>>>
>>>>> Jacopo
>>>>>
>>>>>
>>>>>
>>>>> Thanks,
>>>>>
>>>>>> Michael
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>
>
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

taher
This is now changing the subject of this thread. I recommend starting a new
thread with your concerns clearly laid out.

On Sep 10, 2016 2:24 PM, "Pierre Smits" <[hidden email]> wrote:

> I wonder where the respect for the volunteer (spending his precious time,
> scratching his itch, improving the product) is, when several PMC members
> felt the need to roll over each other *telling* that contributor to follow
> the *rules. *Especially when these rules are not rules, but rather
> advice/suggestions that *can* be followed.
>
> Complaining about a suggestion not followed, especially multiple times, is
> clearly a sign of lack of appreciation of the contribution or respect for
> the contributor. It is neither improving efficiency*,* but rather
> counter-productive.
>
> And what is as bad, is the fact that the persons complaining don't adhere
> to their own advice. In stead of addressing their own actions *first* and
> addressing unassigned issues *secondly*, they thought they would score
> points when they singled out 1 contributor.
>
> That borders on harassment. To put it mildly.
>
> Pierre Smits
>
> ORRTIZ.COM <http://www.orrtiz.com>
> OFBiz based solutions & services
>
> OFBiz Extensions Marketplace
> http://oem.ofbizci.net/oci-2/
>
> On Sat, Sep 10, 2016 at 12:56 PM, Jacques Le Roux <
> [hidden email]> wrote:
>
> > I totally agree with you Taher!
> >
> > Just allow me a small amendment inline :)
> >
> > Le 10/09/2016 à 12:35, Taher Alkhateeb a écrit :
> >
> >> We adhere to these rules out of respect and appreciation to each other,
> >> not
> >> because of fear of consequences.
> >>
> >
> > We *NORMALLY* adhere to these rules out of respect and appreciation to
> > each other, not because of fear of consequences.
> >
> > There are (rare) cases where you need to be OFBiz police, notably with
> > brands and domains.
> > I did that in the past and I will continue...
> >
> > To be complete, I must says these case don't refer to OFBiz specific
> > rules/policies/etc. but to the ASF guidelines notably
> > http://www.apache.org/foundation/marks/domains and globally
> > http://www.apache.org/foundation/marks/resources
> >
> > Most of the time people don't clearly know about these "details" and act
> > on good faith. Simply asking them to follow the guidelines is enough.
> >
> > I think it was a good occasion to expose/remind these ASF rules/policies
> >   Jacques
> >
> >
> > Taher Alkhateeb
> >>
> >> On Sep 10, 2016 12:19 PM, "Pierre Smits" <[hidden email]>
> wrote:
> >>
> >> A rule - in general - implies, that, when not adhered to, there will be
> >>> consequences. What will those consequences be?
> >>> Will the rule police then bitch at the contributor in the same manor
> as a
> >>> few did, when they felt the need to lecture me about how I prioritise
> my
> >>> itch?
> >>>
> >>> Food for thought.
> >>>
> >>> Best regards,
> >>>
> >>> Pierre Smits
> >>>
> >>> ORRTIZ.COM <http://www.orrtiz.com>
> >>> OFBiz based solutions & services
> >>>
> >>> OFBiz Extensions Marketplace
> >>> http://oem.ofbizci.net/oci-2/
> >>>
> >>> On Sat, Sep 10, 2016 at 10:05 AM, Michael Brohl <
> >>> [hidden email]>
> >>> wrote:
> >>>
> >>> Thanks, Jacopo :-)
> >>>>
> >>>> Do you think we can apply the template as a general rule?
> >>>>
> >>>> I will put it in the Wiki then and ask Committers to do their future
> >>>> commits in this way in case they have not followed this discussions or
> >>>> simply forgot. Maybe it will take some time to get used to it.
> >>>>
> >>>> Thanks,
> >>>>
> >>>> Michael
> >>>>
> >>>>
> >>>> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
> >>>>
> >>>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <
> [hidden email]
> >>>> >
> >>>>
> >>>>> wrote:
> >>>>>
> >>>>> ...
> >>>>>
> >>>>>> I've made my last commit using it and also saw that Jacopo (partly
> ;-)
> >>>>>>
> >>>>> )
> >>>
> >>>> applied this in his latest commits.
> >>>>>>
> >>>>>> I have applied the new template to one commit and then I have
> >>>>>> forgotten
> >>>>>>
> >>>>> to
> >>>>> apply it to the second one and I was hoping you didn't notice it :-)
> >>>>> I have fixed the commit log now!
> >>>>>
> >>>>> Jacopo
> >>>>>
> >>>>>
> >>>>>
> >>>>> Thanks,
> >>>>>
> >>>>>> Michael
> >>>>>>
> >>>>>>
> >>>>>>
> >>>>>>
> >>>>>>
> >>>>>>
> >>>>
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Pierre Smits
I recommend you do that if you feel that need.

Pierre Smits

ORRTIZ.COM <http://www.orrtiz.com>
OFBiz based solutions & services

OFBiz Extensions Marketplace
http://oem.ofbizci.net/oci-2/

On Sat, Sep 10, 2016 at 1:31 PM, Taher Alkhateeb <[hidden email]
> wrote:

> This is now changing the subject of this thread. I recommend starting a new
> thread with your concerns clearly laid out.
>
> On Sep 10, 2016 2:24 PM, "Pierre Smits" <[hidden email]> wrote:
>
> > I wonder where the respect for the volunteer (spending his precious time,
> > scratching his itch, improving the product) is, when several PMC members
> > felt the need to roll over each other *telling* that contributor to
> follow
> > the *rules. *Especially when these rules are not rules, but rather
> > advice/suggestions that *can* be followed.
> >
> > Complaining about a suggestion not followed, especially multiple times,
> is
> > clearly a sign of lack of appreciation of the contribution or respect for
> > the contributor. It is neither improving efficiency*,* but rather
> > counter-productive.
> >
> > And what is as bad, is the fact that the persons complaining don't adhere
> > to their own advice. In stead of addressing their own actions *first* and
> > addressing unassigned issues *secondly*, they thought they would score
> > points when they singled out 1 contributor.
> >
> > That borders on harassment. To put it mildly.
> >
> > Pierre Smits
> >
> > ORRTIZ.COM <http://www.orrtiz.com>
> > OFBiz based solutions & services
> >
> > OFBiz Extensions Marketplace
> > http://oem.ofbizci.net/oci-2/
> >
> > On Sat, Sep 10, 2016 at 12:56 PM, Jacques Le Roux <
> > [hidden email]> wrote:
> >
> > > I totally agree with you Taher!
> > >
> > > Just allow me a small amendment inline :)
> > >
> > > Le 10/09/2016 à 12:35, Taher Alkhateeb a écrit :
> > >
> > >> We adhere to these rules out of respect and appreciation to each
> other,
> > >> not
> > >> because of fear of consequences.
> > >>
> > >
> > > We *NORMALLY* adhere to these rules out of respect and appreciation to
> > > each other, not because of fear of consequences.
> > >
> > > There are (rare) cases where you need to be OFBiz police, notably with
> > > brands and domains.
> > > I did that in the past and I will continue...
> > >
> > > To be complete, I must says these case don't refer to OFBiz specific
> > > rules/policies/etc. but to the ASF guidelines notably
> > > http://www.apache.org/foundation/marks/domains and globally
> > > http://www.apache.org/foundation/marks/resources
> > >
> > > Most of the time people don't clearly know about these "details" and
> act
> > > on good faith. Simply asking them to follow the guidelines is enough.
> > >
> > > I think it was a good occasion to expose/remind these ASF
> rules/policies
> > >   Jacques
> > >
> > >
> > > Taher Alkhateeb
> > >>
> > >> On Sep 10, 2016 12:19 PM, "Pierre Smits" <[hidden email]>
> > wrote:
> > >>
> > >> A rule - in general - implies, that, when not adhered to, there will
> be
> > >>> consequences. What will those consequences be?
> > >>> Will the rule police then bitch at the contributor in the same manor
> > as a
> > >>> few did, when they felt the need to lecture me about how I prioritise
> > my
> > >>> itch?
> > >>>
> > >>> Food for thought.
> > >>>
> > >>> Best regards,
> > >>>
> > >>> Pierre Smits
> > >>>
> > >>> ORRTIZ.COM <http://www.orrtiz.com>
> > >>> OFBiz based solutions & services
> > >>>
> > >>> OFBiz Extensions Marketplace
> > >>> http://oem.ofbizci.net/oci-2/
> > >>>
> > >>> On Sat, Sep 10, 2016 at 10:05 AM, Michael Brohl <
> > >>> [hidden email]>
> > >>> wrote:
> > >>>
> > >>> Thanks, Jacopo :-)
> > >>>>
> > >>>> Do you think we can apply the template as a general rule?
> > >>>>
> > >>>> I will put it in the Wiki then and ask Committers to do their future
> > >>>> commits in this way in case they have not followed this discussions
> or
> > >>>> simply forgot. Maybe it will take some time to get used to it.
> > >>>>
> > >>>> Thanks,
> > >>>>
> > >>>> Michael
> > >>>>
> > >>>>
> > >>>> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
> > >>>>
> > >>>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <
> > [hidden email]
> > >>>> >
> > >>>>
> > >>>>> wrote:
> > >>>>>
> > >>>>> ...
> > >>>>>
> > >>>>>> I've made my last commit using it and also saw that Jacopo (partly
> > ;-)
> > >>>>>>
> > >>>>> )
> > >>>
> > >>>> applied this in his latest commits.
> > >>>>>>
> > >>>>>> I have applied the new template to one commit and then I have
> > >>>>>> forgotten
> > >>>>>>
> > >>>>> to
> > >>>>> apply it to the second one and I was hoping you didn't notice it
> :-)
> > >>>>> I have fixed the commit log now!
> > >>>>>
> > >>>>> Jacopo
> > >>>>>
> > >>>>>
> > >>>>>
> > >>>>> Thanks,
> > >>>>>
> > >>>>>> Michael
> > >>>>>>
> > >>>>>>
> > >>>>>>
> > >>>>>>
> > >>>>>>
> > >>>>>>
> > >>>>
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Jacques Le Roux
Administrator
Just to say: not sure how it happened, but I see this thread as a new thread with the same subject in Thunderbird.

Jacques


Le 10/09/2016 à 13:32, Pierre Smits a écrit :

> I recommend you do that if you feel that need.
>
> Pierre Smits
>
> ORRTIZ.COM <http://www.orrtiz.com>
> OFBiz based solutions & services
>
> OFBiz Extensions Marketplace
> http://oem.ofbizci.net/oci-2/
>
> On Sat, Sep 10, 2016 at 1:31 PM, Taher Alkhateeb <[hidden email]
>> wrote:
>> This is now changing the subject of this thread. I recommend starting a new
>> thread with your concerns clearly laid out.
>>
>> On Sep 10, 2016 2:24 PM, "Pierre Smits" <[hidden email]> wrote:
>>
>>> I wonder where the respect for the volunteer (spending his precious time,
>>> scratching his itch, improving the product) is, when several PMC members
>>> felt the need to roll over each other *telling* that contributor to
>> follow
>>> the *rules. *Especially when these rules are not rules, but rather
>>> advice/suggestions that *can* be followed.
>>>
>>> Complaining about a suggestion not followed, especially multiple times,
>> is
>>> clearly a sign of lack of appreciation of the contribution or respect for
>>> the contributor. It is neither improving efficiency*,* but rather
>>> counter-productive.
>>>
>>> And what is as bad, is the fact that the persons complaining don't adhere
>>> to their own advice. In stead of addressing their own actions *first* and
>>> addressing unassigned issues *secondly*, they thought they would score
>>> points when they singled out 1 contributor.
>>>
>>> That borders on harassment. To put it mildly.
>>>
>>> Pierre Smits
>>>
>>> ORRTIZ.COM <http://www.orrtiz.com>
>>> OFBiz based solutions & services
>>>
>>> OFBiz Extensions Marketplace
>>> http://oem.ofbizci.net/oci-2/
>>>
>>> On Sat, Sep 10, 2016 at 12:56 PM, Jacques Le Roux <
>>> [hidden email]> wrote:
>>>
>>>> I totally agree with you Taher!
>>>>
>>>> Just allow me a small amendment inline :)
>>>>
>>>> Le 10/09/2016 à 12:35, Taher Alkhateeb a écrit :
>>>>
>>>>> We adhere to these rules out of respect and appreciation to each
>> other,
>>>>> not
>>>>> because of fear of consequences.
>>>>>
>>>> We *NORMALLY* adhere to these rules out of respect and appreciation to
>>>> each other, not because of fear of consequences.
>>>>
>>>> There are (rare) cases where you need to be OFBiz police, notably with
>>>> brands and domains.
>>>> I did that in the past and I will continue...
>>>>
>>>> To be complete, I must says these case don't refer to OFBiz specific
>>>> rules/policies/etc. but to the ASF guidelines notably
>>>> http://www.apache.org/foundation/marks/domains and globally
>>>> http://www.apache.org/foundation/marks/resources
>>>>
>>>> Most of the time people don't clearly know about these "details" and
>> act
>>>> on good faith. Simply asking them to follow the guidelines is enough.
>>>>
>>>> I think it was a good occasion to expose/remind these ASF
>> rules/policies
>>>>    Jacques
>>>>
>>>>
>>>> Taher Alkhateeb
>>>>> On Sep 10, 2016 12:19 PM, "Pierre Smits" <[hidden email]>
>>> wrote:
>>>>> A rule - in general - implies, that, when not adhered to, there will
>> be
>>>>>> consequences. What will those consequences be?
>>>>>> Will the rule police then bitch at the contributor in the same manor
>>> as a
>>>>>> few did, when they felt the need to lecture me about how I prioritise
>>> my
>>>>>> itch?
>>>>>>
>>>>>> Food for thought.
>>>>>>
>>>>>> Best regards,
>>>>>>
>>>>>> Pierre Smits
>>>>>>
>>>>>> ORRTIZ.COM <http://www.orrtiz.com>
>>>>>> OFBiz based solutions & services
>>>>>>
>>>>>> OFBiz Extensions Marketplace
>>>>>> http://oem.ofbizci.net/oci-2/
>>>>>>
>>>>>> On Sat, Sep 10, 2016 at 10:05 AM, Michael Brohl <
>>>>>> [hidden email]>
>>>>>> wrote:
>>>>>>
>>>>>> Thanks, Jacopo :-)
>>>>>>> Do you think we can apply the template as a general rule?
>>>>>>>
>>>>>>> I will put it in the Wiki then and ask Committers to do their future
>>>>>>> commits in this way in case they have not followed this discussions
>> or
>>>>>>> simply forgot. Maybe it will take some time to get used to it.
>>>>>>>
>>>>>>> Thanks,
>>>>>>>
>>>>>>> Michael
>>>>>>>
>>>>>>>
>>>>>>> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
>>>>>>>
>>>>>>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <
>>> [hidden email]
>>>>>>>> wrote:
>>>>>>>>
>>>>>>>> ...
>>>>>>>>
>>>>>>>>> I've made my last commit using it and also saw that Jacopo (partly
>>> ;-)
>>>>>>>> )
>>>>>>> applied this in his latest commits.
>>>>>>>>> I have applied the new template to one commit and then I have
>>>>>>>>> forgotten
>>>>>>>>>
>>>>>>>> to
>>>>>>>> apply it to the second one and I was hoping you didn't notice it
>> :-)
>>>>>>>> I have fixed the commit log now!
>>>>>>>>
>>>>>>>> Jacopo
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>> Thanks,
>>>>>>>>
>>>>>>>>> Michael
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>

--

Jacques Le Roux
400E Chemin de la Mouline
34560 Poussan
04 67 51 19 38
06 11 79 50 28

Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Jacopo Cappellato-5
Jacques, Pierre,

please keep the focus on this thread's topic: "Proposal for a more unified
commit message format".
Otherwise, you will confuse and distract the community members that are
interested in this subject.

Thank you,

Jacopo


On Sat, Sep 10, 2016 at 2:20 PM, Jacques Le Roux <
[hidden email]> wrote:

> Just to say: not sure how it happened, but I see this thread as a new
> thread with the same subject in Thunderbird.
>
> Jacques
>
>
>
> Le 10/09/2016 à 13:32, Pierre Smits a écrit :
>
>> I recommend you do that if you feel that need.
>>
>> Pierre Smits
>>
>> ORRTIZ.COM <http://www.orrtiz.com>
>> OFBiz based solutions & services
>>
>> OFBiz Extensions Marketplace
>> http://oem.ofbizci.net/oci-2/
>>
>> On Sat, Sep 10, 2016 at 1:31 PM, Taher Alkhateeb <
>> [hidden email]
>>
>>> wrote:
>>> This is now changing the subject of this thread. I recommend starting a
>>> new
>>> thread with your concerns clearly laid out.
>>>
>>> On Sep 10, 2016 2:24 PM, "Pierre Smits" <[hidden email]> wrote:
>>>
>>> I wonder where the respect for the volunteer (spending his precious time,
>>>> scratching his itch, improving the product) is, when several PMC members
>>>> felt the need to roll over each other *telling* that contributor to
>>>>
>>> follow
>>>
>>>> the *rules. *Especially when these rules are not rules, but rather
>>>> advice/suggestions that *can* be followed.
>>>>
>>>> Complaining about a suggestion not followed, especially multiple times,
>>>>
>>> is
>>>
>>>> clearly a sign of lack of appreciation of the contribution or respect
>>>> for
>>>> the contributor. It is neither improving efficiency*,* but rather
>>>> counter-productive.
>>>>
>>>> And what is as bad, is the fact that the persons complaining don't
>>>> adhere
>>>> to their own advice. In stead of addressing their own actions *first*
>>>> and
>>>> addressing unassigned issues *secondly*, they thought they would score
>>>> points when they singled out 1 contributor.
>>>>
>>>> That borders on harassment. To put it mildly.
>>>>
>>>> Pierre Smits
>>>>
>>>> ORRTIZ.COM <http://www.orrtiz.com>
>>>> OFBiz based solutions & services
>>>>
>>>> OFBiz Extensions Marketplace
>>>> http://oem.ofbizci.net/oci-2/
>>>>
>>>> On Sat, Sep 10, 2016 at 12:56 PM, Jacques Le Roux <
>>>> [hidden email]> wrote:
>>>>
>>>> I totally agree with you Taher!
>>>>>
>>>>> Just allow me a small amendment inline :)
>>>>>
>>>>> Le 10/09/2016 à 12:35, Taher Alkhateeb a écrit :
>>>>>
>>>>> We adhere to these rules out of respect and appreciation to each
>>>>>>
>>>>> other,
>>>
>>>> not
>>>>>> because of fear of consequences.
>>>>>>
>>>>>> We *NORMALLY* adhere to these rules out of respect and appreciation to
>>>>> each other, not because of fear of consequences.
>>>>>
>>>>> There are (rare) cases where you need to be OFBiz police, notably with
>>>>> brands and domains.
>>>>> I did that in the past and I will continue...
>>>>>
>>>>> To be complete, I must says these case don't refer to OFBiz specific
>>>>> rules/policies/etc. but to the ASF guidelines notably
>>>>> http://www.apache.org/foundation/marks/domains and globally
>>>>> http://www.apache.org/foundation/marks/resources
>>>>>
>>>>> Most of the time people don't clearly know about these "details" and
>>>>>
>>>> act
>>>
>>>> on good faith. Simply asking them to follow the guidelines is enough.
>>>>>
>>>>> I think it was a good occasion to expose/remind these ASF
>>>>>
>>>> rules/policies
>>>
>>>>    Jacques
>>>>>
>>>>>
>>>>> Taher Alkhateeb
>>>>>
>>>>>> On Sep 10, 2016 12:19 PM, "Pierre Smits" <[hidden email]>
>>>>>>
>>>>> wrote:
>>>>
>>>>> A rule - in general - implies, that, when not adhered to, there will
>>>>>>
>>>>> be
>>>
>>>> consequences. What will those consequences be?
>>>>>>> Will the rule police then bitch at the contributor in the same manor
>>>>>>>
>>>>>> as a
>>>>
>>>>> few did, when they felt the need to lecture me about how I prioritise
>>>>>>>
>>>>>> my
>>>>
>>>>> itch?
>>>>>>>
>>>>>>> Food for thought.
>>>>>>>
>>>>>>> Best regards,
>>>>>>>
>>>>>>> Pierre Smits
>>>>>>>
>>>>>>> ORRTIZ.COM <http://www.orrtiz.com>
>>>>>>> OFBiz based solutions & services
>>>>>>>
>>>>>>> OFBiz Extensions Marketplace
>>>>>>> http://oem.ofbizci.net/oci-2/
>>>>>>>
>>>>>>> On Sat, Sep 10, 2016 at 10:05 AM, Michael Brohl <
>>>>>>> [hidden email]>
>>>>>>> wrote:
>>>>>>>
>>>>>>> Thanks, Jacopo :-)
>>>>>>>
>>>>>>>> Do you think we can apply the template as a general rule?
>>>>>>>>
>>>>>>>> I will put it in the Wiki then and ask Committers to do their future
>>>>>>>> commits in this way in case they have not followed this discussions
>>>>>>>>
>>>>>>> or
>>>
>>>> simply forgot. Maybe it will take some time to get used to it.
>>>>>>>>
>>>>>>>> Thanks,
>>>>>>>>
>>>>>>>> Michael
>>>>>>>>
>>>>>>>>
>>>>>>>> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
>>>>>>>>
>>>>>>>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <
>>>>>>>>
>>>>>>> [hidden email]
>>>>
>>>>> wrote:
>>>>>>>>>
>>>>>>>>> ...
>>>>>>>>>
>>>>>>>>> I've made my last commit using it and also saw that Jacopo (partly
>>>>>>>>>>
>>>>>>>>> ;-)
>>>>
>>>>> )
>>>>>>>>>
>>>>>>>> applied this in his latest commits.
>>>>>>>>
>>>>>>>>> I have applied the new template to one commit and then I have
>>>>>>>>>> forgotten
>>>>>>>>>>
>>>>>>>>>> to
>>>>>>>>> apply it to the second one and I was hoping you didn't notice it
>>>>>>>>>
>>>>>>>> :-)
>>>
>>>> I have fixed the commit log now!
>>>>>>>>>
>>>>>>>>> Jacopo
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>> Thanks,
>>>>>>>>>
>>>>>>>>> Michael
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
>>>>>>>>>>
> --
>
> Jacques Le Roux
> 400E Chemin de la Mouline
> 34560 Poussan
> 04 67 51 19 38
> 06 11 79 50 28
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Michael Brohl-3
In reply to this post by Nicolas Malin-2
Thanks for your feedback, Nicolas!

Regards,

Michael


Am 10.09.16 um 10:42 schrieb Nicolas Malin:

>
> Le 10/09/2016 à 10:05, Michael Brohl a écrit :
>> Thanks, Jacopo :-)
>>
>> Do you think we can apply the template as a general rule?
>>
>> I will put it in the Wiki then and ask Committers to do their future
>> commits in this way in case they have not followed this discussions
>> or simply forgot. Maybe it will take some time to get used to it.
>>
>> Thanks,
> Completely agree. Thanks Michael for this initiative, and I'm sure we
> will need to alert (a fairly cordial manner) at the beginning each
> commit that don't respect this rule. And myself first !
>
> Nicolas


smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Michael Brohl-3
In reply to this post by Michael Brohl-3
I have created a new Wiki page for this topic under
https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+commit+message+template 
and linked it with the "Commiting changes" part of the "OFBiz Committers
Roles and Responsibilities"  page here:
https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+Committers+Roles+and+Responsibilities

Feedback and remarks welcome!

Thanks,

Michael


Am 10.09.16 um 10:05 schrieb Michael Brohl:

> Thanks, Jacopo :-)
>
> Do you think we can apply the template as a general rule?
>
> I will put it in the Wiki then and ask Committers to do their future
> commits in this way in case they have not followed this discussions or
> simply forgot. Maybe it will take some time to get used to it.
>
> Thanks,
>
> Michael
>
>
> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]>
>> wrote:
>>
>>> ...
>>> I've made my last commit using it and also saw that Jacopo (partly
>>> ;-) )
>>> applied this in his latest commits.
>>>
>> I have applied the new template to one commit and then I have
>> forgotten to
>> apply it to the second one and I was hoping you didn't notice it :-)
>> I have fixed the commit log now!
>>
>> Jacopo
>>
>>
>>
>>> Thanks,
>>>
>>> Michael
>>>
>>>
>>>
>>>
>
>


smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

taher
Looks good Michael, +1

I would add a recommendation that I mentioned earlier, which is to restrict
the width and to add an empty line between the sections for better
readability.

if you issue the command svn log you will notice that it separates the
commits with dashes (72 dashes to be exact). So if we can restrict the
width to say 80 characters, then the output of svn log will look nice and
and easy to read. For example, a commit message might look like this

===== commit message starts =====
Improved: error message logged by DelegatorFactoryImpl.getInstance(...)

(OFBIZ-12345)

The error message is triggered by the above method when a delegator can't
be created; added a TODO comment to remind that the code should be
refactored to throw the exception instead.
===== commit message ends =====

p.s. Jacopo I botched your commit message for the above sample :)

Cheers,

Taher Alkhateeb

On Sun, Sep 11, 2016 at 2:59 PM, Michael Brohl <[hidden email]>
wrote:

> I have created a new Wiki page for this topic under
> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
> commit+message+template and linked it with the "Commiting changes" part
> of the "OFBiz Committers Roles and Responsibilities"  page here:
> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
> Committers+Roles+and+Responsibilities
>
> Feedback and remarks welcome!
>
> Thanks,
>
> Michael
>
>
> Am 10.09.16 um 10:05 schrieb Michael Brohl:
>
> Thanks, Jacopo :-)
>>
>> Do you think we can apply the template as a general rule?
>>
>> I will put it in the Wiki then and ask Committers to do their future
>> commits in this way in case they have not followed this discussions or
>> simply forgot. Maybe it will take some time to get used to it.
>>
>> Thanks,
>>
>> Michael
>>
>>
>> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
>>
>>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]>
>>> wrote:
>>>
>>> ...
>>>> I've made my last commit using it and also saw that Jacopo (partly ;-) )
>>>> applied this in his latest commits.
>>>>
>>>> I have applied the new template to one commit and then I have forgotten
>>> to
>>> apply it to the second one and I was hoping you didn't notice it :-)
>>> I have fixed the commit log now!
>>>
>>> Jacopo
>>>
>>>
>>>
>>> Thanks,
>>>>
>>>> Michael
>>>>
>>>>
>>>>
>>>>
>>>>
>>
>>
>
>
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

Michael Brohl-3
Taher,

thanks for your feedback!

If you look closely, I already have mentioned your suggestions for blank
lines as separators and the max. width of 80 characters in the rules
section below the template.

I have adjusted the examples to be max. 80 chars wide.

Thanks,

Michael


Am 11.09.16 um 14:29 schrieb Taher Alkhateeb:

> Looks good Michael, +1
>
> I would add a recommendation that I mentioned earlier, which is to restrict
> the width and to add an empty line between the sections for better
> readability.
>
> if you issue the command svn log you will notice that it separates the
> commits with dashes (72 dashes to be exact). So if we can restrict the
> width to say 80 characters, then the output of svn log will look nice and
> and easy to read. For example, a commit message might look like this
>
> ===== commit message starts =====
> Improved: error message logged by DelegatorFactoryImpl.getInstance(...)
>
> (OFBIZ-12345)
>
> The error message is triggered by the above method when a delegator can't
> be created; added a TODO comment to remind that the code should be
> refactored to throw the exception instead.
> ===== commit message ends =====
>
> p.s. Jacopo I botched your commit message for the above sample :)
>
> Cheers,
>
> Taher Alkhateeb
>
> On Sun, Sep 11, 2016 at 2:59 PM, Michael Brohl <[hidden email]>
> wrote:
>
>> I have created a new Wiki page for this topic under
>> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
>> commit+message+template and linked it with the "Commiting changes" part
>> of the "OFBiz Committers Roles and Responsibilities"  page here:
>> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
>> Committers+Roles+and+Responsibilities
>>
>> Feedback and remarks welcome!
>>
>> Thanks,
>>
>> Michael
>>
>>
>> Am 10.09.16 um 10:05 schrieb Michael Brohl:
>>
>> Thanks, Jacopo :-)
>>> Do you think we can apply the template as a general rule?
>>>
>>> I will put it in the Wiki then and ask Committers to do their future
>>> commits in this way in case they have not followed this discussions or
>>> simply forgot. Maybe it will take some time to get used to it.
>>>
>>> Thanks,
>>>
>>> Michael
>>>
>>>
>>> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
>>>
>>>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]>
>>>> wrote:
>>>>
>>>> ...
>>>>> I've made my last commit using it and also saw that Jacopo (partly ;-) )
>>>>> applied this in his latest commits.
>>>>>
>>>>> I have applied the new template to one commit and then I have forgotten
>>>> to
>>>> apply it to the second one and I was hoping you didn't notice it :-)
>>>> I have fixed the commit log now!
>>>>
>>>> Jacopo
>>>>
>>>>
>>>>
>>>> Thanks,
>>>>> Michael
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>
>>


smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: Proposal for a more unified commit message format

taher
Ahh, right I missed reading that bullet. With the updated examples it looks
great! Thank you for the effort.

On Sun, Sep 11, 2016 at 4:06 PM, Michael Brohl <[hidden email]>
wrote:

> Taher,
>
> thanks for your feedback!
>
> If you look closely, I already have mentioned your suggestions for blank
> lines as separators and the max. width of 80 characters in the rules
> section below the template.
>
> I have adjusted the examples to be max. 80 chars wide.
>
> Thanks,
>
> Michael
>
>
> Am 11.09.16 um 14:29 schrieb Taher Alkhateeb:
>
> Looks good Michael, +1
>>
>> I would add a recommendation that I mentioned earlier, which is to
>> restrict
>> the width and to add an empty line between the sections for better
>> readability.
>>
>> if you issue the command svn log you will notice that it separates the
>> commits with dashes (72 dashes to be exact). So if we can restrict the
>> width to say 80 characters, then the output of svn log will look nice and
>> and easy to read. For example, a commit message might look like this
>>
>> ===== commit message starts =====
>> Improved: error message logged by DelegatorFactoryImpl.getInstance(...)
>>
>> (OFBIZ-12345)
>>
>> The error message is triggered by the above method when a delegator can't
>> be created; added a TODO comment to remind that the code should be
>> refactored to throw the exception instead.
>> ===== commit message ends =====
>>
>> p.s. Jacopo I botched your commit message for the above sample :)
>>
>> Cheers,
>>
>> Taher Alkhateeb
>>
>> On Sun, Sep 11, 2016 at 2:59 PM, Michael Brohl <[hidden email]>
>> wrote:
>>
>> I have created a new Wiki page for this topic under
>>> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
>>> commit+message+template and linked it with the "Commiting changes" part
>>> of the "OFBiz Committers Roles and Responsibilities"  page here:
>>> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
>>> Committers+Roles+and+Responsibilities
>>>
>>> Feedback and remarks welcome!
>>>
>>> Thanks,
>>>
>>> Michael
>>>
>>>
>>> Am 10.09.16 um 10:05 schrieb Michael Brohl:
>>>
>>> Thanks, Jacopo :-)
>>>
>>>> Do you think we can apply the template as a general rule?
>>>>
>>>> I will put it in the Wiki then and ask Committers to do their future
>>>> commits in this way in case they have not followed this discussions or
>>>> simply forgot. Maybe it will take some time to get used to it.
>>>>
>>>> Thanks,
>>>>
>>>> Michael
>>>>
>>>>
>>>> Am 10.09.16 um 07:55 schrieb Jacopo Cappellato:
>>>>
>>>> On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <[hidden email]
>>>>> >
>>>>> wrote:
>>>>>
>>>>> ...
>>>>>
>>>>>> I've made my last commit using it and also saw that Jacopo (partly
>>>>>> ;-) )
>>>>>> applied this in his latest commits.
>>>>>>
>>>>>> I have applied the new template to one commit and then I have
>>>>>> forgotten
>>>>>>
>>>>> to
>>>>> apply it to the second one and I was hoping you didn't notice it :-)
>>>>> I have fixed the commit log now!
>>>>>
>>>>> Jacopo
>>>>>
>>>>>
>>>>>
>>>>> Thanks,
>>>>>
>>>>>> Michael
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>
>>>
>
>
123