You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ofbiz.apache.org by Michael Brohl <mi...@ecomify.de> on 2016/09/06 08:08:03 UTC
Proposal for a more unified commit message format
Fellow committers,
as you might know, I'm preparing the monthly development details (mostly
related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
This is currently a lot of manual work (expecially when we have
Community Days!) mostly because the commit messages I use as the source
are not unified and written in different formats (Jira reference at the
beginning, among the text or end, different line separators, unnecessary
or doubled informations like mentioning Jira while also giving the Jira
issue etc.). Each developer has his/her own style :-)
I'd like to propose a more unified format (or template) for the commit
messages which we can put in the Best Practices part of our Wiki.
My proposal for a unified format would be:
===
[Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
title|Free text] [(OFBIZ-xxxx)]
[Details:] [More detailed explanation of what has been done and what the
fix achieves, sideeffects etc.]
[Thanks:] [xxxx for ... and yyyy for]
===
Some rules:
* line 1 is mandatory, the following lines are optional
* line 1: a ":" follows after the kind of implementation/source of work
* line 1: the Jira title must not be quoted (""), the Jira reference
should be in parenthesis, no whitespace.
* no separators between the lines, just new lines
This would help a lot for the preparation of the blog and would also
make the reading of the commit logs (command line and IDE) much easier,
especially when they are displayed as one-liners.
What do you think?
Regards,
Michael Brohl
ecomify GmbH
www.ecomify.de
Re: Proposal for a more unified commit message format
Posted by Nicolas Malin <ni...@nereide.fr>.
I like this proposal
Nicolas
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
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
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
>
Re: Proposal for a more unified commit message format
Posted by Taher Alkhateeb <sl...@gmail.com>.
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 <mi...@ecomify.de>
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 <mi...@ecomify.de>
>> 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 <michael.brohl@ecomify.de
>>>>> >
>>>>> 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
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>
>>>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
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 <mi...@ecomify.de>
> 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 <mi...@ecomify.de>
>>>> 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
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>
>>
Re: Proposal for a more unified commit message format
Posted by Taher Alkhateeb <sl...@gmail.com>.
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 <mi...@ecomify.de>
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 <mi...@ecomify.de>
>>> 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
>>>>
>>>>
>>>>
>>>>
>>>>
>>
>>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
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 <mi...@ecomify.de>
>> 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
>>>
>>>
>>>
>>>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
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
Re: Proposal for a more unified commit message format
Posted by Nicolas Malin <ni...@nereide.fr>.
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
Re: Proposal for a more unified commit message format
Posted by Jacques Le Roux <ja...@les7arts.com>.
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" <pi...@gmail.com> 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 <mi...@ecomify.de>
>> 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 <mi...@ecomify.de>
>>>> 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
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>
Re: Proposal for a more unified commit message format
Posted by Taher Alkhateeb <sl...@gmail.com>.
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" <pi...@gmail.com> 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 <mi...@ecomify.de>
> 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 <mi...@ecomify.de>
> >> 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
> >>>
> >>>
> >>>
> >>>
> >>>
> >
> >
>
Re: Proposal for a more unified commit message format
Posted by Pierre Smits <pi...@gmail.com>.
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 <mi...@ecomify.de>
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 <mi...@ecomify.de>
>> 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
>>>
>>>
>>>
>>>
>>>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
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 <mi...@ecomify.de>
> 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
>>
>>
>>
>>
Re: Proposal for a more unified commit message format
Posted by Jacopo Cappellato <ja...@hotwaxsystems.com>.
On Fri, Sep 9, 2016 at 6:29 PM, Michael Brohl <mi...@ecomify.de>
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
>
>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
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
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
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
Re: Proposal for a more unified commit message format
Posted by Jacques Le Roux <ja...@les7arts.com>.
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
Re: Proposal for a more unified commit message format
Posted by Jacopo Cappellato <ja...@hotwaxsystems.com>.
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
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
Yes, that might make it clearer.
I will give some examples of existing log messages and how they would
look with the new format.
Example 1 (old):
===
Applied patch from jira issue - OFBIZ-8091 - Clean up commented out code
in XML for Common component. Thanks Aman for the contribution.
===
Example 1 (new):
===
Applied patch for: Clean up commented out code in XML for Common
component ( OFBIZ-8091).
Thanks: Aman for the contribution.
===
Example 2 (old):
===
(OFBIZ-7969) Applied slightly modified patch from jira issue.
=================================
Enable adding a content to an agreement
=================================
Thanks Leila Mekika for your contribution.
===
Example 2 (new):
===
Applied modified patch for: Enable adding a content to an agreement (
OFBIZ-7969).
Thanks: Leila Mekika for your contribution.
===
Example 3 (old): (no Jira)
===
Improved error message logged by DelegatorFactoryImpl.getInstance(...)
when a delegator can't be created; added a TODO comment to remind that
the code should be refactored to throw the exception instead.
===
Example 3 (new):
===
Improved: error message logged by DelegatorFactoryImpl.getInstance(...)
when a delegator can't be created.
Details: added a TODO comment to remind that the code should be
refactored to throw the exception instead.
===
Example 4 (old):
===
A slightly modified Taher's patch for "Load the OWASP dependency checker
Gradle plugin efficiently" I reported at OFBIZ-7930
Using OWASP-DC with Gradle was impossible w/o the corresponding plugin.
Unfortunately using the suggested way at
https://plugins.gradle.org/plugin/org.owasp.dependencycheck loads a lot
of dependencies which are only needed by OWASP-DC. So Taher wrote a
specific solution to avoid downloading useless libs to a normal use of
OFBiz, there it is.
jleroux: I have simply formatted the "if(" to "if ("
===
Example 4 (new):
===
Applied modified patch: Load the OWASP dependency checker Gradle plugin
efficiently (OFBIZ-7930).
Details: Using OWASP-DC with Gradle was impossible w/o the corresponding
plugin. Unfortunately using the suggested way at
https://plugins.gradle.org/plugin/org.owasp.dependencycheck loads a lot
of dependencies which are only needed by OWASP-DC. So Taher wrote a
specific solution to avoid downloading useless libs to a normal use of
OFBiz, there it is.
jleroux: I have simply formatted the "if(" to "if ("
===
Example 2 made me enhance the template:
===
[Applied patch for|Applied modified patch for|Implemented|Improved|Fix for|Documentation]: [Jira title|Free text] [(OFBIZ-xxxx)]
[Details:] [More detailed explanation of what has been done and what the fix achieves, sideeffects etc.]
[Thanks:] [xxxx for ... and yyyy for]
===
Hope that's clearer now?
Regards,
Michael
Am 06.09.16 um 11:26 schrieb Taher Alkhateeb:
> Can you include some samples Michael, just for clarity?
>
> On Tue, Sep 6, 2016 at 12:25 PM, Taher Alkhateeb <slidingfilaments@gmail.com
>> wrote:
>> +1
>>
>> I also suggest to have maximum width of 80 characters. This makes things
>> nicer and cleaner for svn log
>>
>> On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
>> gil.portenseigne@nereide.fr> wrote:
>>
>>> Hi Michael,
>>>
>>> I like the idea to have unified commit message format.
>>>
>>> +1
>>>
>>> Thanks for the proposal !
>>> Gil
>>>
>>>
>>> On 06/09/2016 10:08, Michael Brohl wrote:
>>>
>>> Fellow committers,
>>>
>>> as you might know, I'm preparing the monthly development details (mostly
>>> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>>>
>>> This is currently a lot of manual work (expecially when we have Community
>>> Days!) mostly because the commit messages I use as the source are not
>>> unified and written in different formats (Jira reference at the beginning,
>>> among the text or end, different line separators, unnecessary or doubled
>>> informations like mentioning Jira while also giving the Jira issue etc.).
>>> Each developer has his/her own style :-)
>>>
>>> I'd like to propose a more unified format (or template) for the commit
>>> messages which we can put in the Best Practices part of our Wiki.
>>>
>>> My proposal for a unified format would be:
>>>
>>>
>>> ===
>>>
>>> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
>>> title|Free text] [(OFBIZ-xxxx)]
>>>
>>> [Details:] [More detailed explanation of what has been done and what the
>>> fix achieves, sideeffects etc.]
>>>
>>> [Thanks:] [xxxx for ... and yyyy for]
>>>
>>> ===
>>>
>>>
>>> Some rules:
>>>
>>> * line 1 is mandatory, the following lines are optional
>>>
>>> * line 1: a ":" follows after the kind of implementation/source of work
>>>
>>> * line 1: the Jira title must not be quoted (""), the Jira reference
>>> should be in parenthesis, no whitespace.
>>>
>>> * no separators between the lines, just new lines
>>>
>>>
>>> This would help a lot for the preparation of the blog and would also make
>>> the reading of the commit logs (command line and IDE) much easier,
>>> especially when they are displayed as one-liners.
>>>
>>>
>>> What do you think?
>>>
>>> Regards,
>>>
>>> Michael Brohl
>>> ecomify GmbH
>>> www.ecomify.de
>>>
>>>
>>>
>>>
>>>
Re: Proposal for a more unified commit message format
Posted by Taher Alkhateeb <sl...@gmail.com>.
Can you include some samples Michael, just for clarity?
On Tue, Sep 6, 2016 at 12:25 PM, Taher Alkhateeb <slidingfilaments@gmail.com
> wrote:
> +1
>
> I also suggest to have maximum width of 80 characters. This makes things
> nicer and cleaner for svn log
>
> On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
> gil.portenseigne@nereide.fr> wrote:
>
>> Hi Michael,
>>
>> I like the idea to have unified commit message format.
>>
>> +1
>>
>> Thanks for the proposal !
>> Gil
>>
>>
>> On 06/09/2016 10:08, Michael Brohl wrote:
>>
>> Fellow committers,
>>
>> as you might know, I'm preparing the monthly development details (mostly
>> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>>
>> This is currently a lot of manual work (expecially when we have Community
>> Days!) mostly because the commit messages I use as the source are not
>> unified and written in different formats (Jira reference at the beginning,
>> among the text or end, different line separators, unnecessary or doubled
>> informations like mentioning Jira while also giving the Jira issue etc.).
>> Each developer has his/her own style :-)
>>
>> I'd like to propose a more unified format (or template) for the commit
>> messages which we can put in the Best Practices part of our Wiki.
>>
>> My proposal for a unified format would be:
>>
>>
>> ===
>>
>> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
>> title|Free text] [(OFBIZ-xxxx)]
>>
>> [Details:] [More detailed explanation of what has been done and what the
>> fix achieves, sideeffects etc.]
>>
>> [Thanks:] [xxxx for ... and yyyy for]
>>
>> ===
>>
>>
>> Some rules:
>>
>> * line 1 is mandatory, the following lines are optional
>>
>> * line 1: a ":" follows after the kind of implementation/source of work
>>
>> * line 1: the Jira title must not be quoted (""), the Jira reference
>> should be in parenthesis, no whitespace.
>>
>> * no separators between the lines, just new lines
>>
>>
>> This would help a lot for the preparation of the blog and would also make
>> the reading of the commit logs (command line and IDE) much easier,
>> especially when they are displayed as one-liners.
>>
>>
>> What do you think?
>>
>> Regards,
>>
>> Michael Brohl
>> ecomify GmbH
>> www.ecomify.de
>>
>>
>>
>>
>>
>
Re: Proposal for a more unified commit message format
Posted by Jacques Le Roux <ja...@les7arts.com>.
BTW, when we initially spoke about "that" with Michael (before this thread while working on the monthly blog post) I thought that an easier way to
generate the detailed Jira issues notes would be to use Jira itself.
Unfortunately if this works well for releases, you can't filter dates on the trunk so you always get all the possible related issues (ie a LOT)
So I have then created this question https://answers.atlassian.com/questions/41455836/have-a-date-filter-to-configure-release-notes#
But I see no signs of activity, and I'll appreciate if you could push it a bit to see what happen. I believe it's a minor change to them which could
benefit to a lot of users.
Thanks (note that you might need to register then)
Jacques
Le 06/09/2016 � 17:51, Jacques Le Roux a �crit :
> Thanks for the tip Michael,
>
> Unfortunately does not work for recent issues.
>
> https://www.bing.com/search?q=OFBIZ-8142&form=MOZESB&pc=MOZT .
>
> BTW same for Google
>
> https://www.google.fr/search?q=OFBIZ-8142&ie=UTF-8
>
> Both have not yet indexed this page, it works for older pages
>
> Jacques
>
>
> Le 06/09/2016 � 16:24, Michael Brohl a �crit :
>> Hi Jacques,
>>
>> You can just mark the Jira number in the message, right-click on it and do a Bing search :-)
>> Ok, its not one click though...
>>
>> Am 06.09.16 um 15:36 schrieb Jacques Le Roux:
>>> Le 06/09/2016 � 14:39, Michael Brohl a �crit :
>>>> I agree, the full Url in the commit message first line is too long.
>>>>
>>>> Jacques, where/in which tool do you need the Url?
>>>
>>> Thunderbird mostly to quickly get to the Jira in Firefox w/o C/P the issue number and add it in an URL in place of an existing issue open, this to
>>> review, follow, etc.
>>>
>>> Taher's idea is OK to me, but anyway I think we don't want to enforce that as a policy, and if I'm the only "lazy" person, better to forget it :D.
>>>
>>> Jacques
>>>
>>
>>
>
>
Re: Proposal for a more unified commit message format
Posted by Jacques Le Roux <ja...@les7arts.com>.
Thanks for the tip Michael,
Unfortunately does not work for recent issues.
https://www.bing.com/search?q=OFBIZ-8142&form=MOZESB&pc=MOZT .
BTW same for Google
https://www.google.fr/search?q=OFBIZ-8142&ie=UTF-8
Both have not yet indexed this page, it works for older pages
Jacques
Le 06/09/2016 � 16:24, Michael Brohl a �crit :
> Hi Jacques,
>
> You can just mark the Jira number in the message, right-click on it and do a Bing search :-)
> Ok, its not one click though...
>
> Am 06.09.16 um 15:36 schrieb Jacques Le Roux:
>> Le 06/09/2016 � 14:39, Michael Brohl a �crit :
>>> I agree, the full Url in the commit message first line is too long.
>>>
>>> Jacques, where/in which tool do you need the Url?
>>
>> Thunderbird mostly to quickly get to the Jira in Firefox w/o C/P the issue number and add it in an URL in place of an existing issue open, this to
>> review, follow, etc.
>>
>> Taher's idea is OK to me, but anyway I think we don't want to enforce that as a policy, and if I'm the only "lazy" person, better to forget it :D.
>>
>> Jacques
>>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
Hi Jacques,
You can just mark the Jira number in the message, right-click on it and
do a Bing search :-)
Ok, its not one click though...
Am 06.09.16 um 15:36 schrieb Jacques Le Roux:
> Le 06/09/2016 à 14:39, Michael Brohl a écrit :
>> I agree, the full Url in the commit message first line is too long.
>>
>> Jacques, where/in which tool do you need the Url?
>
> Thunderbird mostly to quickly get to the Jira in Firefox w/o C/P the
> issue number and add it in an URL in place of an existing issue open,
> this to review, follow, etc.
>
> Taher's idea is OK to me, but anyway I think we don't want to enforce
> that as a policy, and if I'm the only "lazy" person, better to forget
> it :D.
>
> Jacques
>
Re: Proposal for a more unified commit message format
Posted by Jacques Le Roux <ja...@les7arts.com>.
Le 06/09/2016 � 14:39, Michael Brohl a �crit :
> I agree, the full Url in the commit message first line is too long.
>
> Jacques, where/in which tool do you need the Url?
Thunderbird mostly to quickly get to the Jira in Firefox w/o C/P the issue number and add it in an URL in place of an existing issue open, this to
review, follow, etc.
Taher's idea is OK to me, but anyway I think we don't want to enforce that as a policy, and if I'm the only "lazy" person, better to forget it :D.
Jacques
>
>
> Am 06.09.16 um 14:22 schrieb Taher Alkhateeb:
>> If we put the full URL in the first line then it might become too long. I
>> would suggest instead to write the full URL if you want to below the first
>> line (anywhere you like) and type the first line as Michael suggested.
>>
>> On Tue, Sep 6, 2016 at 3:17 PM, Jacques Le Roux <
>> jacques.le.roux@les7arts.com> wrote:
>>
>>> I agree with Michael, here and above.
>>>
>>> Just a minor favour, not a problem if not possible.
>>>
>>> Would it be tolerable to also use https://issues.apache.org/jira
>>> /browse/OFBIZ-xxxx instead of OFBIZ-xxxx?
>>> I like to be able to not have to C/P, and rather just click (how many
>>> times do I during a day?).
>>> It's not a problem for Atlassian tools, they parse the same.
>>>
>>> Jacques
>>>
>>>
>>>
>>> Le 06/09/2016 � 12:15, Michael Brohl a �crit :
>>>
>>>> Ah, I see, misunderstood you intention.
>>>>
>>>> I think we can take it as a guideline but at command line and e.g.
>>>> Eclipse you don't have a character count when committing so that could be a
>>>> hurdle.
>>>>
>>>>
>>>> Am 06.09.16 um 12:00 schrieb Taher Alkhateeb:
>>>>
>>>>> Hi Michael,
>>>>>
>>>>> I meant a new line after 80 characters. If you review my commit messages
>>>>> that I usually how I do it (I hit the return key and keep on typing).
>>>>> Not a
>>>>> big deal but the output becomes nice on most screens.
>>>>>
>>>>> On Tue, Sep 6, 2016 at 12:55 PM, Michael Brohl <michael.brohl@ecomify.de
>>>>> wrote:
>>>>>
>>>>> Taher,
>>>>>> I would not put a general limit on the length of the commit message.
>>>>>> There
>>>>>> are sometimes valuable informations in longer messages I'd like not to
>>>>>> miss.
>>>>>>
>>>>>>
>>>>>> Am 06.09.16 um 11:25 schrieb Taher Alkhateeb:
>>>>>>
>>>>>> +1
>>>>>>
>>>>>>> I also suggest to have maximum width of 80 characters. This makes
>>>>>>> things
>>>>>>> nicer and cleaner for svn log
>>>>>>>
>>>>>>> On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
>>>>>>> gil.portenseigne@nereide.fr> wrote:
>>>>>>>
>>>>>>> Hi Michael,
>>>>>>>
>>>>>>>> I like the idea to have unified commit message format.
>>>>>>>>
>>>>>>>> +1
>>>>>>>>
>>>>>>>> Thanks for the proposal !
>>>>>>>> Gil
>>>>>>>>
>>>>>>>>
>>>>>>>> On 06/09/2016 10:08, Michael Brohl wrote:
>>>>>>>>
>>>>>>>> Fellow committers,
>>>>>>>>
>>>>>>>> as you might know, I'm preparing the monthly development details
>>>>>>>> (mostly
>>>>>>>> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>>>>>>>>
>>>>>>>> This is currently a lot of manual work (expecially when we have
>>>>>>>> Community
>>>>>>>> Days!) mostly because the commit messages I use as the source are not
>>>>>>>> unified and written in different formats (Jira reference at the
>>>>>>>> beginning,
>>>>>>>> among the text or end, different line separators, unnecessary or
>>>>>>>> doubled
>>>>>>>> informations like mentioning Jira while also giving the Jira issue
>>>>>>>> etc.).
>>>>>>>> Each developer has his/her own style :-)
>>>>>>>>
>>>>>>>> I'd like to propose a more unified format (or template) for the commit
>>>>>>>> messages which we can put in the Best Practices part of our Wiki.
>>>>>>>>
>>>>>>>> My proposal for a unified format would be:
>>>>>>>>
>>>>>>>>
>>>>>>>> ===
>>>>>>>>
>>>>>>>> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
>>>>>>>> title|Free text] [(OFBIZ-xxxx)]
>>>>>>>>
>>>>>>>> [Details:] [More detailed explanation of what has been done and what
>>>>>>>> the
>>>>>>>> fix achieves, sideeffects etc.]
>>>>>>>>
>>>>>>>> [Thanks:] [xxxx for ... and yyyy for]
>>>>>>>>
>>>>>>>> ===
>>>>>>>>
>>>>>>>>
>>>>>>>> Some rules:
>>>>>>>>
>>>>>>>> * line 1 is mandatory, the following lines are optional
>>>>>>>>
>>>>>>>> * line 1: a ":" follows after the kind of implementation/source of
>>>>>>>> work
>>>>>>>>
>>>>>>>> * line 1: the Jira title must not be quoted (""), the Jira reference
>>>>>>>> should be in parenthesis, no whitespace.
>>>>>>>>
>>>>>>>> * no separators between the lines, just new lines
>>>>>>>>
>>>>>>>>
>>>>>>>> This would help a lot for the preparation of the blog and would also
>>>>>>>> make
>>>>>>>> the reading of the commit logs (command line and IDE) much easier,
>>>>>>>> especially when they are displayed as one-liners.
>>>>>>>>
>>>>>>>>
>>>>>>>> What do you think?
>>>>>>>>
>>>>>>>> Regards,
>>>>>>>>
>>>>>>>> Michael Brohl
>>>>>>>> ecomify GmbH
>>>>>>>> www.ecomify.de
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
I agree, the full Url in the commit message first line is too long.
Jacques, where/in which tool do you need the Url?
Am 06.09.16 um 14:22 schrieb Taher Alkhateeb:
> If we put the full URL in the first line then it might become too long. I
> would suggest instead to write the full URL if you want to below the first
> line (anywhere you like) and type the first line as Michael suggested.
>
> On Tue, Sep 6, 2016 at 3:17 PM, Jacques Le Roux <
> jacques.le.roux@les7arts.com> wrote:
>
>> I agree with Michael, here and above.
>>
>> Just a minor favour, not a problem if not possible.
>>
>> Would it be tolerable to also use https://issues.apache.org/jira
>> /browse/OFBIZ-xxxx instead of OFBIZ-xxxx?
>> I like to be able to not have to C/P, and rather just click (how many
>> times do I during a day?).
>> It's not a problem for Atlassian tools, they parse the same.
>>
>> Jacques
>>
>>
>>
>> Le 06/09/2016 à 12:15, Michael Brohl a écrit :
>>
>>> Ah, I see, misunderstood you intention.
>>>
>>> I think we can take it as a guideline but at command line and e.g.
>>> Eclipse you don't have a character count when committing so that could be a
>>> hurdle.
>>>
>>>
>>> Am 06.09.16 um 12:00 schrieb Taher Alkhateeb:
>>>
>>>> Hi Michael,
>>>>
>>>> I meant a new line after 80 characters. If you review my commit messages
>>>> that I usually how I do it (I hit the return key and keep on typing).
>>>> Not a
>>>> big deal but the output becomes nice on most screens.
>>>>
>>>> On Tue, Sep 6, 2016 at 12:55 PM, Michael Brohl <michael.brohl@ecomify.de
>>>> wrote:
>>>>
>>>> Taher,
>>>>> I would not put a general limit on the length of the commit message.
>>>>> There
>>>>> are sometimes valuable informations in longer messages I'd like not to
>>>>> miss.
>>>>>
>>>>>
>>>>> Am 06.09.16 um 11:25 schrieb Taher Alkhateeb:
>>>>>
>>>>> +1
>>>>>
>>>>>> I also suggest to have maximum width of 80 characters. This makes
>>>>>> things
>>>>>> nicer and cleaner for svn log
>>>>>>
>>>>>> On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
>>>>>> gil.portenseigne@nereide.fr> wrote:
>>>>>>
>>>>>> Hi Michael,
>>>>>>
>>>>>>> I like the idea to have unified commit message format.
>>>>>>>
>>>>>>> +1
>>>>>>>
>>>>>>> Thanks for the proposal !
>>>>>>> Gil
>>>>>>>
>>>>>>>
>>>>>>> On 06/09/2016 10:08, Michael Brohl wrote:
>>>>>>>
>>>>>>> Fellow committers,
>>>>>>>
>>>>>>> as you might know, I'm preparing the monthly development details
>>>>>>> (mostly
>>>>>>> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>>>>>>>
>>>>>>> This is currently a lot of manual work (expecially when we have
>>>>>>> Community
>>>>>>> Days!) mostly because the commit messages I use as the source are not
>>>>>>> unified and written in different formats (Jira reference at the
>>>>>>> beginning,
>>>>>>> among the text or end, different line separators, unnecessary or
>>>>>>> doubled
>>>>>>> informations like mentioning Jira while also giving the Jira issue
>>>>>>> etc.).
>>>>>>> Each developer has his/her own style :-)
>>>>>>>
>>>>>>> I'd like to propose a more unified format (or template) for the commit
>>>>>>> messages which we can put in the Best Practices part of our Wiki.
>>>>>>>
>>>>>>> My proposal for a unified format would be:
>>>>>>>
>>>>>>>
>>>>>>> ===
>>>>>>>
>>>>>>> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
>>>>>>> title|Free text] [(OFBIZ-xxxx)]
>>>>>>>
>>>>>>> [Details:] [More detailed explanation of what has been done and what
>>>>>>> the
>>>>>>> fix achieves, sideeffects etc.]
>>>>>>>
>>>>>>> [Thanks:] [xxxx for ... and yyyy for]
>>>>>>>
>>>>>>> ===
>>>>>>>
>>>>>>>
>>>>>>> Some rules:
>>>>>>>
>>>>>>> * line 1 is mandatory, the following lines are optional
>>>>>>>
>>>>>>> * line 1: a ":" follows after the kind of implementation/source of
>>>>>>> work
>>>>>>>
>>>>>>> * line 1: the Jira title must not be quoted (""), the Jira reference
>>>>>>> should be in parenthesis, no whitespace.
>>>>>>>
>>>>>>> * no separators between the lines, just new lines
>>>>>>>
>>>>>>>
>>>>>>> This would help a lot for the preparation of the blog and would also
>>>>>>> make
>>>>>>> the reading of the commit logs (command line and IDE) much easier,
>>>>>>> especially when they are displayed as one-liners.
>>>>>>>
>>>>>>>
>>>>>>> What do you think?
>>>>>>>
>>>>>>> Regards,
>>>>>>>
>>>>>>> Michael Brohl
>>>>>>> ecomify GmbH
>>>>>>> www.ecomify.de
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>
Re: Proposal for a more unified commit message format
Posted by Taher Alkhateeb <sl...@gmail.com>.
If we put the full URL in the first line then it might become too long. I
would suggest instead to write the full URL if you want to below the first
line (anywhere you like) and type the first line as Michael suggested.
On Tue, Sep 6, 2016 at 3:17 PM, Jacques Le Roux <
jacques.le.roux@les7arts.com> wrote:
> I agree with Michael, here and above.
>
> Just a minor favour, not a problem if not possible.
>
> Would it be tolerable to also use https://issues.apache.org/jira
> /browse/OFBIZ-xxxx instead of OFBIZ-xxxx?
> I like to be able to not have to C/P, and rather just click (how many
> times do I during a day?).
> It's not a problem for Atlassian tools, they parse the same.
>
> Jacques
>
>
>
> Le 06/09/2016 à 12:15, Michael Brohl a écrit :
>
>> Ah, I see, misunderstood you intention.
>>
>> I think we can take it as a guideline but at command line and e.g.
>> Eclipse you don't have a character count when committing so that could be a
>> hurdle.
>>
>>
>> Am 06.09.16 um 12:00 schrieb Taher Alkhateeb:
>>
>>> Hi Michael,
>>>
>>> I meant a new line after 80 characters. If you review my commit messages
>>> that I usually how I do it (I hit the return key and keep on typing).
>>> Not a
>>> big deal but the output becomes nice on most screens.
>>>
>>> On Tue, Sep 6, 2016 at 12:55 PM, Michael Brohl <michael.brohl@ecomify.de
>>> >
>>> wrote:
>>>
>>> Taher,
>>>>
>>>> I would not put a general limit on the length of the commit message.
>>>> There
>>>> are sometimes valuable informations in longer messages I'd like not to
>>>> miss.
>>>>
>>>>
>>>> Am 06.09.16 um 11:25 schrieb Taher Alkhateeb:
>>>>
>>>> +1
>>>>
>>>>> I also suggest to have maximum width of 80 characters. This makes
>>>>> things
>>>>> nicer and cleaner for svn log
>>>>>
>>>>> On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
>>>>> gil.portenseigne@nereide.fr> wrote:
>>>>>
>>>>> Hi Michael,
>>>>>
>>>>>> I like the idea to have unified commit message format.
>>>>>>
>>>>>> +1
>>>>>>
>>>>>> Thanks for the proposal !
>>>>>> Gil
>>>>>>
>>>>>>
>>>>>> On 06/09/2016 10:08, Michael Brohl wrote:
>>>>>>
>>>>>> Fellow committers,
>>>>>>
>>>>>> as you might know, I'm preparing the monthly development details
>>>>>> (mostly
>>>>>> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>>>>>>
>>>>>> This is currently a lot of manual work (expecially when we have
>>>>>> Community
>>>>>> Days!) mostly because the commit messages I use as the source are not
>>>>>> unified and written in different formats (Jira reference at the
>>>>>> beginning,
>>>>>> among the text or end, different line separators, unnecessary or
>>>>>> doubled
>>>>>> informations like mentioning Jira while also giving the Jira issue
>>>>>> etc.).
>>>>>> Each developer has his/her own style :-)
>>>>>>
>>>>>> I'd like to propose a more unified format (or template) for the commit
>>>>>> messages which we can put in the Best Practices part of our Wiki.
>>>>>>
>>>>>> My proposal for a unified format would be:
>>>>>>
>>>>>>
>>>>>> ===
>>>>>>
>>>>>> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
>>>>>> title|Free text] [(OFBIZ-xxxx)]
>>>>>>
>>>>>> [Details:] [More detailed explanation of what has been done and what
>>>>>> the
>>>>>> fix achieves, sideeffects etc.]
>>>>>>
>>>>>> [Thanks:] [xxxx for ... and yyyy for]
>>>>>>
>>>>>> ===
>>>>>>
>>>>>>
>>>>>> Some rules:
>>>>>>
>>>>>> * line 1 is mandatory, the following lines are optional
>>>>>>
>>>>>> * line 1: a ":" follows after the kind of implementation/source of
>>>>>> work
>>>>>>
>>>>>> * line 1: the Jira title must not be quoted (""), the Jira reference
>>>>>> should be in parenthesis, no whitespace.
>>>>>>
>>>>>> * no separators between the lines, just new lines
>>>>>>
>>>>>>
>>>>>> This would help a lot for the preparation of the blog and would also
>>>>>> make
>>>>>> the reading of the commit logs (command line and IDE) much easier,
>>>>>> especially when they are displayed as one-liners.
>>>>>>
>>>>>>
>>>>>> What do you think?
>>>>>>
>>>>>> Regards,
>>>>>>
>>>>>> Michael Brohl
>>>>>> ecomify GmbH
>>>>>> www.ecomify.de
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>>
>>
>>
>
Re: Proposal for a more unified commit message format
Posted by Jacques Le Roux <ja...@les7arts.com>.
I agree with Michael, here and above.
Just a minor favour, not a problem if not possible.
Would it be tolerable to also use https://issues.apache.org/jira/browse/OFBIZ-xxxx instead of OFBIZ-xxxx?
I like to be able to not have to C/P, and rather just click (how many times do I during a day?).
It's not a problem for Atlassian tools, they parse the same.
Jacques
Le 06/09/2016 � 12:15, Michael Brohl a �crit :
> Ah, I see, misunderstood you intention.
>
> I think we can take it as a guideline but at command line and e.g. Eclipse you don't have a character count when committing so that could be a hurdle.
>
>
> Am 06.09.16 um 12:00 schrieb Taher Alkhateeb:
>> Hi Michael,
>>
>> I meant a new line after 80 characters. If you review my commit messages
>> that I usually how I do it (I hit the return key and keep on typing). Not a
>> big deal but the output becomes nice on most screens.
>>
>> On Tue, Sep 6, 2016 at 12:55 PM, Michael Brohl <mi...@ecomify.de>
>> wrote:
>>
>>> Taher,
>>>
>>> I would not put a general limit on the length of the commit message. There
>>> are sometimes valuable informations in longer messages I'd like not to miss.
>>>
>>>
>>> Am 06.09.16 um 11:25 schrieb Taher Alkhateeb:
>>>
>>> +1
>>>> I also suggest to have maximum width of 80 characters. This makes things
>>>> nicer and cleaner for svn log
>>>>
>>>> On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
>>>> gil.portenseigne@nereide.fr> wrote:
>>>>
>>>> Hi Michael,
>>>>> I like the idea to have unified commit message format.
>>>>>
>>>>> +1
>>>>>
>>>>> Thanks for the proposal !
>>>>> Gil
>>>>>
>>>>>
>>>>> On 06/09/2016 10:08, Michael Brohl wrote:
>>>>>
>>>>> Fellow committers,
>>>>>
>>>>> as you might know, I'm preparing the monthly development details (mostly
>>>>> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>>>>>
>>>>> This is currently a lot of manual work (expecially when we have Community
>>>>> Days!) mostly because the commit messages I use as the source are not
>>>>> unified and written in different formats (Jira reference at the
>>>>> beginning,
>>>>> among the text or end, different line separators, unnecessary or doubled
>>>>> informations like mentioning Jira while also giving the Jira issue
>>>>> etc.).
>>>>> Each developer has his/her own style :-)
>>>>>
>>>>> I'd like to propose a more unified format (or template) for the commit
>>>>> messages which we can put in the Best Practices part of our Wiki.
>>>>>
>>>>> My proposal for a unified format would be:
>>>>>
>>>>>
>>>>> ===
>>>>>
>>>>> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
>>>>> title|Free text] [(OFBIZ-xxxx)]
>>>>>
>>>>> [Details:] [More detailed explanation of what has been done and what the
>>>>> fix achieves, sideeffects etc.]
>>>>>
>>>>> [Thanks:] [xxxx for ... and yyyy for]
>>>>>
>>>>> ===
>>>>>
>>>>>
>>>>> Some rules:
>>>>>
>>>>> * line 1 is mandatory, the following lines are optional
>>>>>
>>>>> * line 1: a ":" follows after the kind of implementation/source of work
>>>>>
>>>>> * line 1: the Jira title must not be quoted (""), the Jira reference
>>>>> should be in parenthesis, no whitespace.
>>>>>
>>>>> * no separators between the lines, just new lines
>>>>>
>>>>>
>>>>> This would help a lot for the preparation of the blog and would also make
>>>>> the reading of the commit logs (command line and IDE) much easier,
>>>>> especially when they are displayed as one-liners.
>>>>>
>>>>>
>>>>> What do you think?
>>>>>
>>>>> Regards,
>>>>>
>>>>> Michael Brohl
>>>>> ecomify GmbH
>>>>> www.ecomify.de
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
Ah, I see, misunderstood you intention.
I think we can take it as a guideline but at command line and e.g.
Eclipse you don't have a character count when committing so that could
be a hurdle.
Am 06.09.16 um 12:00 schrieb Taher Alkhateeb:
> Hi Michael,
>
> I meant a new line after 80 characters. If you review my commit messages
> that I usually how I do it (I hit the return key and keep on typing). Not a
> big deal but the output becomes nice on most screens.
>
> On Tue, Sep 6, 2016 at 12:55 PM, Michael Brohl <mi...@ecomify.de>
> wrote:
>
>> Taher,
>>
>> I would not put a general limit on the length of the commit message. There
>> are sometimes valuable informations in longer messages I'd like not to miss.
>>
>>
>> Am 06.09.16 um 11:25 schrieb Taher Alkhateeb:
>>
>> +1
>>> I also suggest to have maximum width of 80 characters. This makes things
>>> nicer and cleaner for svn log
>>>
>>> On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
>>> gil.portenseigne@nereide.fr> wrote:
>>>
>>> Hi Michael,
>>>> I like the idea to have unified commit message format.
>>>>
>>>> +1
>>>>
>>>> Thanks for the proposal !
>>>> Gil
>>>>
>>>>
>>>> On 06/09/2016 10:08, Michael Brohl wrote:
>>>>
>>>> Fellow committers,
>>>>
>>>> as you might know, I'm preparing the monthly development details (mostly
>>>> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>>>>
>>>> This is currently a lot of manual work (expecially when we have Community
>>>> Days!) mostly because the commit messages I use as the source are not
>>>> unified and written in different formats (Jira reference at the
>>>> beginning,
>>>> among the text or end, different line separators, unnecessary or doubled
>>>> informations like mentioning Jira while also giving the Jira issue
>>>> etc.).
>>>> Each developer has his/her own style :-)
>>>>
>>>> I'd like to propose a more unified format (or template) for the commit
>>>> messages which we can put in the Best Practices part of our Wiki.
>>>>
>>>> My proposal for a unified format would be:
>>>>
>>>>
>>>> ===
>>>>
>>>> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
>>>> title|Free text] [(OFBIZ-xxxx)]
>>>>
>>>> [Details:] [More detailed explanation of what has been done and what the
>>>> fix achieves, sideeffects etc.]
>>>>
>>>> [Thanks:] [xxxx for ... and yyyy for]
>>>>
>>>> ===
>>>>
>>>>
>>>> Some rules:
>>>>
>>>> * line 1 is mandatory, the following lines are optional
>>>>
>>>> * line 1: a ":" follows after the kind of implementation/source of work
>>>>
>>>> * line 1: the Jira title must not be quoted (""), the Jira reference
>>>> should be in parenthesis, no whitespace.
>>>>
>>>> * no separators between the lines, just new lines
>>>>
>>>>
>>>> This would help a lot for the preparation of the blog and would also make
>>>> the reading of the commit logs (command line and IDE) much easier,
>>>> especially when they are displayed as one-liners.
>>>>
>>>>
>>>> What do you think?
>>>>
>>>> Regards,
>>>>
>>>> Michael Brohl
>>>> ecomify GmbH
>>>> www.ecomify.de
>>>>
>>>>
>>>>
>>>>
>>>>
>>>>
>>
Re: Proposal for a more unified commit message format
Posted by Taher Alkhateeb <sl...@gmail.com>.
Hi Michael,
I meant a new line after 80 characters. If you review my commit messages
that I usually how I do it (I hit the return key and keep on typing). Not a
big deal but the output becomes nice on most screens.
On Tue, Sep 6, 2016 at 12:55 PM, Michael Brohl <mi...@ecomify.de>
wrote:
> Taher,
>
> I would not put a general limit on the length of the commit message. There
> are sometimes valuable informations in longer messages I'd like not to miss.
>
>
> Am 06.09.16 um 11:25 schrieb Taher Alkhateeb:
>
> +1
>>
>> I also suggest to have maximum width of 80 characters. This makes things
>> nicer and cleaner for svn log
>>
>> On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
>> gil.portenseigne@nereide.fr> wrote:
>>
>> Hi Michael,
>>>
>>> I like the idea to have unified commit message format.
>>>
>>> +1
>>>
>>> Thanks for the proposal !
>>> Gil
>>>
>>>
>>> On 06/09/2016 10:08, Michael Brohl wrote:
>>>
>>> Fellow committers,
>>>
>>> as you might know, I'm preparing the monthly development details (mostly
>>> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>>>
>>> This is currently a lot of manual work (expecially when we have Community
>>> Days!) mostly because the commit messages I use as the source are not
>>> unified and written in different formats (Jira reference at the
>>> beginning,
>>> among the text or end, different line separators, unnecessary or doubled
>>> informations like mentioning Jira while also giving the Jira issue
>>> etc.).
>>> Each developer has his/her own style :-)
>>>
>>> I'd like to propose a more unified format (or template) for the commit
>>> messages which we can put in the Best Practices part of our Wiki.
>>>
>>> My proposal for a unified format would be:
>>>
>>>
>>> ===
>>>
>>> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
>>> title|Free text] [(OFBIZ-xxxx)]
>>>
>>> [Details:] [More detailed explanation of what has been done and what the
>>> fix achieves, sideeffects etc.]
>>>
>>> [Thanks:] [xxxx for ... and yyyy for]
>>>
>>> ===
>>>
>>>
>>> Some rules:
>>>
>>> * line 1 is mandatory, the following lines are optional
>>>
>>> * line 1: a ":" follows after the kind of implementation/source of work
>>>
>>> * line 1: the Jira title must not be quoted (""), the Jira reference
>>> should be in parenthesis, no whitespace.
>>>
>>> * no separators between the lines, just new lines
>>>
>>>
>>> This would help a lot for the preparation of the blog and would also make
>>> the reading of the commit logs (command line and IDE) much easier,
>>> especially when they are displayed as one-liners.
>>>
>>>
>>> What do you think?
>>>
>>> Regards,
>>>
>>> Michael Brohl
>>> ecomify GmbH
>>> www.ecomify.de
>>>
>>>
>>>
>>>
>>>
>>>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
Taher,
I would not put a general limit on the length of the commit message.
There are sometimes valuable informations in longer messages I'd like
not to miss.
Am 06.09.16 um 11:25 schrieb Taher Alkhateeb:
> +1
>
> I also suggest to have maximum width of 80 characters. This makes things
> nicer and cleaner for svn log
>
> On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
> gil.portenseigne@nereide.fr> wrote:
>
>> Hi Michael,
>>
>> I like the idea to have unified commit message format.
>>
>> +1
>>
>> Thanks for the proposal !
>> Gil
>>
>>
>> On 06/09/2016 10:08, Michael Brohl wrote:
>>
>> Fellow committers,
>>
>> as you might know, I'm preparing the monthly development details (mostly
>> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>>
>> This is currently a lot of manual work (expecially when we have Community
>> Days!) mostly because the commit messages I use as the source are not
>> unified and written in different formats (Jira reference at the beginning,
>> among the text or end, different line separators, unnecessary or doubled
>> informations like mentioning Jira while also giving the Jira issue etc.).
>> Each developer has his/her own style :-)
>>
>> I'd like to propose a more unified format (or template) for the commit
>> messages which we can put in the Best Practices part of our Wiki.
>>
>> My proposal for a unified format would be:
>>
>>
>> ===
>>
>> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
>> title|Free text] [(OFBIZ-xxxx)]
>>
>> [Details:] [More detailed explanation of what has been done and what the
>> fix achieves, sideeffects etc.]
>>
>> [Thanks:] [xxxx for ... and yyyy for]
>>
>> ===
>>
>>
>> Some rules:
>>
>> * line 1 is mandatory, the following lines are optional
>>
>> * line 1: a ":" follows after the kind of implementation/source of work
>>
>> * line 1: the Jira title must not be quoted (""), the Jira reference
>> should be in parenthesis, no whitespace.
>>
>> * no separators between the lines, just new lines
>>
>>
>> This would help a lot for the preparation of the blog and would also make
>> the reading of the commit logs (command line and IDE) much easier,
>> especially when they are displayed as one-liners.
>>
>>
>> What do you think?
>>
>> Regards,
>>
>> Michael Brohl
>> ecomify GmbH
>> www.ecomify.de
>>
>>
>>
>>
>>
Re: Proposal for a more unified commit message format
Posted by Taher Alkhateeb <sl...@gmail.com>.
+1
I also suggest to have maximum width of 80 characters. This makes things
nicer and cleaner for svn log
On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne <
gil.portenseigne@nereide.fr> wrote:
> Hi Michael,
>
> I like the idea to have unified commit message format.
>
> +1
>
> Thanks for the proposal !
> Gil
>
>
> On 06/09/2016 10:08, Michael Brohl wrote:
>
> Fellow committers,
>
> as you might know, I'm preparing the monthly development details (mostly
> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>
> This is currently a lot of manual work (expecially when we have Community
> Days!) mostly because the commit messages I use as the source are not
> unified and written in different formats (Jira reference at the beginning,
> among the text or end, different line separators, unnecessary or doubled
> informations like mentioning Jira while also giving the Jira issue etc.).
> Each developer has his/her own style :-)
>
> I'd like to propose a more unified format (or template) for the commit
> messages which we can put in the Best Practices part of our Wiki.
>
> My proposal for a unified format would be:
>
>
> ===
>
> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
> title|Free text] [(OFBIZ-xxxx)]
>
> [Details:] [More detailed explanation of what has been done and what the
> fix achieves, sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
>
> ===
>
>
> Some rules:
>
> * line 1 is mandatory, the following lines are optional
>
> * line 1: a ":" follows after the kind of implementation/source of work
>
> * line 1: the Jira title must not be quoted (""), the Jira reference
> should be in parenthesis, no whitespace.
>
> * no separators between the lines, just new lines
>
>
> This would help a lot for the preparation of the blog and would also make
> the reading of the commit logs (command line and IDE) much easier,
> especially when they are displayed as one-liners.
>
>
> What do you think?
>
> Regards,
>
> Michael Brohl
> ecomify GmbH
> www.ecomify.de
>
>
>
>
>
Re: Proposal for a more unified commit message format
Posted by gil portenseigne <gi...@nereide.fr>.
Hi Michael,
I like the idea to have unified commit message format.
+1
Thanks for the proposal !
Gil
On 06/09/2016 10:08, Michael Brohl wrote:
> Fellow committers,
>
> as you might know, I'm preparing the monthly development details
> (mostly related to Jiras) for our blog at
> https://blogs.apache.org/ofbiz/.
>
> This is currently a lot of manual work (expecially when we have
> Community Days!) mostly because the commit messages I use as the
> source are not unified and written in different formats (Jira
> reference at the beginning, among the text or end, different line
> separators, unnecessary or doubled informations like mentioning Jira
> while also giving the Jira issue etc.). Each developer has his/her
> own style :-)
>
> I'd like to propose a more unified format (or template) for the commit
> messages which we can put in the Best Practices part of our Wiki.
>
> My proposal for a unified format would be:
>
>
> ===
>
> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
> title|Free text] [(OFBIZ-xxxx)]
>
> [Details:] [More detailed explanation of what has been done and what
> the fix achieves, sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
>
> ===
>
>
> Some rules:
>
> * line 1 is mandatory, the following lines are optional
>
> * line 1: a ":" follows after the kind of implementation/source of work
>
> * line 1: the Jira title must not be quoted (""), the Jira reference
> should be in parenthesis, no whitespace.
>
> * no separators between the lines, just new lines
>
>
> This would help a lot for the preparation of the blog and would also
> make the reading of the commit logs (command line and IDE) much
> easier, especially when they are displayed as one-liners.
>
>
> What do you think?
>
> Regards,
>
> Michael Brohl
> ecomify GmbH
> www.ecomify.de
>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
There's another reason: in the blog, it's more convenient to have the
Jira reference and link at the end of the description.
As long as we do it manually, we would have to cut/paste every Jira
reference to the end.
Michael
Am 06.09.16 um 10:21 schrieb Michael Brohl:
> Thanks for your suggestion, Pierre!
>
> I thought about that but choose to put it at the end because it's
> optional (in case we don't have a Jira related to this commit).
>
> Regards,
>
> Michael
>
>
> Am 06.09.16 um 10:17 schrieb Pierre Smits:
>> Hi Michael,
>>
>> Would it not be more convenient to have the JIRA issue number first? And
>> then the rest as per your suggestion?
>>
>> Best regards,
>>
>>
>> Pierre Smits
>>
>>
>
>
Re: Proposal for a more unified commit message format
Posted by Michael Brohl <mi...@ecomify.de>.
Thanks for your suggestion, Pierre!
I thought about that but choose to put it at the end because it's
optional (in case we don't have a Jira related to this commit).
Regards,
Michael
Am 06.09.16 um 10:17 schrieb Pierre Smits:
> Hi Michael,
>
> Would it not be more convenient to have the JIRA issue number first? And
> then the rest as per your suggestion?
>
> Best regards,
>
>
> Pierre Smits
>
>
Re: Proposal for a more unified commit message format
Posted by Pierre Smits <pi...@gmail.com>.
Hi Michael,
Would it not be more convenient to have the JIRA issue number first? And
then the rest as per your suggestion?
Best regards,
Pierre Smits
ORRTIZ.COM <http://www.orrtiz.com>
OFBiz based solutions & services
OFBiz Extensions Marketplace
http://oem.ofbizci.net/oci-2/
On Tue, Sep 6, 2016 at 10:08 AM, Michael Brohl <mi...@ecomify.de>
wrote:
> Fellow committers,
>
> as you might know, I'm preparing the monthly development details (mostly
> related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>
> This is currently a lot of manual work (expecially when we have Community
> Days!) mostly because the commit messages I use as the source are not
> unified and written in different formats (Jira reference at the beginning,
> among the text or end, different line separators, unnecessary or doubled
> informations like mentioning Jira while also giving the Jira issue etc.).
> Each developer has his/her own style :-)
>
> I'd like to propose a more unified format (or template) for the commit
> messages which we can put in the Best Practices part of our Wiki.
>
> My proposal for a unified format would be:
>
>
> ===
>
> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira
> title|Free text] [(OFBIZ-xxxx)]
>
> [Details:] [More detailed explanation of what has been done and what the
> fix achieves, sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
>
> ===
>
>
> Some rules:
>
> * line 1 is mandatory, the following lines are optional
>
> * line 1: a ":" follows after the kind of implementation/source of work
>
> * line 1: the Jira title must not be quoted (""), the Jira reference
> should be in parenthesis, no whitespace.
>
> * no separators between the lines, just new lines
>
>
> This would help a lot for the preparation of the blog and would also make
> the reading of the commit logs (command line and IDE) much easier,
> especially when they are displayed as one-liners.
>
>
> What do you think?
>
> Regards,
>
> Michael Brohl
> ecomify GmbH
> www.ecomify.de
>
>
>
>
Re: Proposal for a more unified commit message format
Posted by Jacques Le Roux <ja...@les7arts.com>.
Hi All,
We initialled missed something: what would you put for Tasks?
I suggest "Completes:" (and not "Does:"). You can use "Completed:" if you want I don't care
Jacques
Le 06/09/2016 � 10:08, Michael Brohl a �crit :
> Fellow committers,
>
> as you might know, I'm preparing the monthly development details (mostly related to Jiras) for our blog at https://blogs.apache.org/ofbiz/.
>
> This is currently a lot of manual work (expecially when we have Community Days!) mostly because the commit messages I use as the source are not
> unified and written in different formats (Jira reference at the beginning, among the text or end, different line separators, unnecessary or doubled
> informations like mentioning Jira while also giving the Jira issue etc.). Each developer has his/her own style :-)
>
> I'd like to propose a more unified format (or template) for the commit messages which we can put in the Best Practices part of our Wiki.
>
> My proposal for a unified format would be:
>
>
> ===
>
> [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira title|Free text] [(OFBIZ-xxxx)]
>
> [Details:] [More detailed explanation of what has been done and what the fix achieves, sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
>
> ===
>
>
> Some rules:
>
> * line 1 is mandatory, the following lines are optional
>
> * line 1: a ":" follows after the kind of implementation/source of work
>
> * line 1: the Jira title must not be quoted (""), the Jira reference should be in parenthesis, no whitespace.
>
> * no separators between the lines, just new lines
>
>
> This would help a lot for the preparation of the blog and would also make the reading of the commit logs (command line and IDE) much easier,
> especially when they are displayed as one-liners.
>
>
> What do you think?
>
> Regards,
>
> Michael Brohl
> ecomify GmbH
> www.ecomify.de
>
>
>