You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ofbiz.apache.org by Jacques Le Roux <ja...@les7arts.com> on 2020/05/20 09:01:45 UTC
Modify OFBiz commit message template
Hi,
With Git IMO it's convenient (more information) to have the Jira number in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
If nobody disagree I'd like to modify
https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
We could have
----
[Implemented | Improved | Fixed | Completed| Documented | Reverted]: [Jira title | Free text] [(OFBIZ-xxxx)]
[(OFBIZ-xxxx)]
[More detailed explanation of what has been done and what the fix achieves,
sideeffects etc.]
[Thanks:] [xxxx for ... and yyyy for]
----
But I would prefer:
----
[Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
----
Opinions?
Thanks
Jacques
Re: Modify OFBiz commit message template
Posted by Mridul Pathak <mr...@hotwaxsystems.com>.
+1
Thanks.
--
Mridul Pathak
> On 20-May-2020, at 2:31 PM, Jacques Le Roux <ja...@les7arts.com> wrote:
>
> Hi,
>
> With Git IMO it's convenient (more information) to have the Jira number in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
>
> If nobody disagree I'd like to modify
>
> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>
> We could have
>
> ----
>
> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [Jira title | Free text] [(OFBIZ-xxxx)]
>
> [(OFBIZ-xxxx)]
>
> [More detailed explanation of what has been done and what the fix achieves,
> sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
>
> ----
>
> But I would prefer:
> ----
> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
>
> ----
> Opinions?
>
> Thanks
>
> Jacques
>
Re: Modify OFBiz commit message template
Posted by Suraj Khurana <su...@hotwax.co>.
+1
--
Best Regards,
Suraj Khurana
Senior Technical Consultant
On Wed, May 20, 2020 at 2:33 PM Jacques Le Roux <
jacques.le.roux@les7arts.com> wrote:
> Hi,
>
> With Git IMO it's convenient (more information) to have the Jira number in
> the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
>
> If nobody disagree I'd like to modify
>
>
> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>
> We could have
>
> ----
>
> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [Jira
> title | Free text] [(OFBIZ-xxxx)]
>
> [(OFBIZ-xxxx)]
>
> [More detailed explanation of what has been done and what the fix achieves,
> sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
>
> ----
>
> But I would prefer:
> ----
> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
>
> ----
> Opinions?
>
> Thanks
>
> Jacques
>
>
Re: Modify OFBiz commit message template
Posted by Jacques Le Roux <ja...@les7arts.com>.
I created https://issues.apache.org/jira/browse/OFBIZ-11298 for that
Le 22/05/2020 à 08:58, Jacques Le Roux a écrit :
> Thanks All,
>
> I'll do that in 5 days, simple, efficient in Git.
>
> Jacques
>
> Le 20/05/2020 à 16:43, James Yong a écrit :
>> +1 to
>>
>> ----
>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
>> ----
>>
>> Regards,
>> James
>>
>>
>> On 2020/05/20 09:01:45, Jacques Le Roux <ja...@les7arts.com> wrote:
>>> Hi,
>>>
>>> With Git IMO it's convenient (more information) to have the Jira number in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
>>>
>>> If nobody disagree I'd like to modify
>>>
>>> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>>>
>>> We could have
>>>
>>> ----
>>>
>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [Jira title | Free text] [(OFBIZ-xxxx)]
>>>
>>> [(OFBIZ-xxxx)]
>>>
>>> [More detailed explanation of what has been done and what the fix achieves,
>>> sideeffects etc.]
>>>
>>> [Thanks:] [xxxx for ... and yyyy for]
>>>
>>> ----
>>>
>>> But I would prefer:
>>> ----
>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
>>>
>>> ----
>>> Opinions?
>>>
>>> Thanks
>>>
>>> Jacques
>>>
>>>
Re: Modify OFBiz commit message template
Posted by Jacques Le Roux <ja...@les7arts.com>.
See the thread
Le 22/05/2020 à 11:01, Pierre Smits a écrit :
> I meant this one:
> https://ofbiz.markmail.org/message/zllitqewumbefwd2?q=Github+PR+request+list:org%2Eapache%2Eofbiz%2Edev+order:date-backward&page=1
>
> Met vriendelijke groet,
>
> Pierre Smits
> *Proud* *contributor** of* Apache OFBiz <https://ofbiz.apache.org/> since
> 2008 (without privileges)
>
> *Apache Trafodion <https://trafodion.apache.org>, Vice President*
> *Apache Directory <https://directory.apache.org>, PMC Member*
> Apache Incubator <https://incubator.apache.org>, committer
> Apache Steve <https://steve.apache.org>, committer
>
>
> On Fri, May 22, 2020 at 10:08 AM Jacques Le Roux <
> jacques.le.roux@les7arts.com> wrote:
>
>> You mean the sonarcloud[bot] thread?
>>
>> Le 22/05/2020 à 09:34, Pierre Smits a écrit :
>>> A few days ago a thread was also started regarding the PR.
>>>
>>> Is that now void? Or will it be handled in the same breath?
>>>
>>> Op vr 22 mei 2020 09:08 schreef Jacques Le Roux <
>>> jacques.le.roux@les7arts.com>:
>>>
>>>> Thanks All,
>>>>
>>>> I'll do that in 5 days, simple, efficient in Git.
>>>>
>>>> Jacques
>>>>
>>>> Le 20/05/2020 à 16:43, James Yong a écrit :
>>>>> +1 to
>>>>>
>>>>> ----
>>>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
>>>> [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]
>>>>> ----
>>>>>
>>>>> Regards,
>>>>> James
>>>>>
>>>>>
>>>>> On 2020/05/20 09:01:45, Jacques Le Roux <ja...@les7arts.com>
>>>> wrote:
>>>>>> Hi,
>>>>>>
>>>>>> With Git IMO it's convenient (more information) to have the Jira
>> number
>>>> in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
>>>>>> If nobody disagree I'd like to modify
>>>>>>
>>>>>>
>> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>>>>>> We could have
>>>>>>
>>>>>> ----
>>>>>>
>>>>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
>>>> [Jira title | Free text] [(OFBIZ-xxxx)]
>>>>>> [(OFBIZ-xxxx)]
>>>>>>
>>>>>> [More detailed explanation of what has been done and what the fix
>>>> achieves,
>>>>>> sideeffects etc.]
>>>>>>
>>>>>> [Thanks:] [xxxx for ... and yyyy for]
>>>>>>
>>>>>> ----
>>>>>>
>>>>>> But I would prefer:
>>>>>> ----
>>>>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
>>>> [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]
>>>>>>
>>>>>> ----
>>>>>> Opinions?
>>>>>>
>>>>>> Thanks
>>>>>>
>>>>>> Jacques
>>>>>>
>>>>>>
Re: Modify OFBiz commit message template
Posted by Pierre Smits <pi...@apache.org>.
I meant this one:
https://ofbiz.markmail.org/message/zllitqewumbefwd2?q=Github+PR+request+list:org%2Eapache%2Eofbiz%2Edev+order:date-backward&page=1
Met vriendelijke groet,
Pierre Smits
*Proud* *contributor** of* Apache OFBiz <https://ofbiz.apache.org/> since
2008 (without privileges)
*Apache Trafodion <https://trafodion.apache.org>, Vice President*
*Apache Directory <https://directory.apache.org>, PMC Member*
Apache Incubator <https://incubator.apache.org>, committer
Apache Steve <https://steve.apache.org>, committer
On Fri, May 22, 2020 at 10:08 AM Jacques Le Roux <
jacques.le.roux@les7arts.com> wrote:
> You mean the sonarcloud[bot] thread?
>
> Le 22/05/2020 à 09:34, Pierre Smits a écrit :
> > A few days ago a thread was also started regarding the PR.
> >
> > Is that now void? Or will it be handled in the same breath?
> >
> > Op vr 22 mei 2020 09:08 schreef Jacques Le Roux <
> > jacques.le.roux@les7arts.com>:
> >
> >> Thanks All,
> >>
> >> I'll do that in 5 days, simple, efficient in Git.
> >>
> >> Jacques
> >>
> >> Le 20/05/2020 à 16:43, James Yong a écrit :
> >>> +1 to
> >>>
> >>> ----
> >>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
> >> [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]
> >>> ----
> >>>
> >>> Regards,
> >>> James
> >>>
> >>>
> >>> On 2020/05/20 09:01:45, Jacques Le Roux <ja...@les7arts.com>
> >> wrote:
> >>>> Hi,
> >>>>
> >>>> With Git IMO it's convenient (more information) to have the Jira
> number
> >> in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
> >>>> If nobody disagree I'd like to modify
> >>>>
> >>>>
> >>
> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
> >>>> We could have
> >>>>
> >>>> ----
> >>>>
> >>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
> >> [Jira title | Free text] [(OFBIZ-xxxx)]
> >>>> [(OFBIZ-xxxx)]
> >>>>
> >>>> [More detailed explanation of what has been done and what the fix
> >> achieves,
> >>>> sideeffects etc.]
> >>>>
> >>>> [Thanks:] [xxxx for ... and yyyy for]
> >>>>
> >>>> ----
> >>>>
> >>>> But I would prefer:
> >>>> ----
> >>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
> >> [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]
> >>>>
> >>>> ----
> >>>> Opinions?
> >>>>
> >>>> Thanks
> >>>>
> >>>> Jacques
> >>>>
> >>>>
>
Re: Modify OFBiz commit message template
Posted by Jacques Le Roux <ja...@les7arts.com>.
You mean the sonarcloud[bot] thread?
Le 22/05/2020 à 09:34, Pierre Smits a écrit :
> A few days ago a thread was also started regarding the PR.
>
> Is that now void? Or will it be handled in the same breath?
>
> Op vr 22 mei 2020 09:08 schreef Jacques Le Roux <
> jacques.le.roux@les7arts.com>:
>
>> Thanks All,
>>
>> I'll do that in 5 days, simple, efficient in Git.
>>
>> Jacques
>>
>> Le 20/05/2020 à 16:43, James Yong a écrit :
>>> +1 to
>>>
>>> ----
>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
>> [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]
>>> ----
>>>
>>> Regards,
>>> James
>>>
>>>
>>> On 2020/05/20 09:01:45, Jacques Le Roux <ja...@les7arts.com>
>> wrote:
>>>> Hi,
>>>>
>>>> With Git IMO it's convenient (more information) to have the Jira number
>> in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
>>>> If nobody disagree I'd like to modify
>>>>
>>>>
>> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>>>> We could have
>>>>
>>>> ----
>>>>
>>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
>> [Jira title | Free text] [(OFBIZ-xxxx)]
>>>> [(OFBIZ-xxxx)]
>>>>
>>>> [More detailed explanation of what has been done and what the fix
>> achieves,
>>>> sideeffects etc.]
>>>>
>>>> [Thanks:] [xxxx for ... and yyyy for]
>>>>
>>>> ----
>>>>
>>>> But I would prefer:
>>>> ----
>>>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
>> [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]
>>>>
>>>> ----
>>>> Opinions?
>>>>
>>>> Thanks
>>>>
>>>> Jacques
>>>>
>>>>
Re: Modify OFBiz commit message template
Posted by Pierre Smits <pi...@apache.org>.
A few days ago a thread was also started regarding the PR.
Is that now void? Or will it be handled in the same breath?
Op vr 22 mei 2020 09:08 schreef Jacques Le Roux <
jacques.le.roux@les7arts.com>:
> Thanks All,
>
> I'll do that in 5 days, simple, efficient in Git.
>
> Jacques
>
> Le 20/05/2020 à 16:43, James Yong a écrit :
> > +1 to
> >
> > ----
> > [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
> [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]
> > ----
> >
> > Regards,
> > James
> >
> >
> > On 2020/05/20 09:01:45, Jacques Le Roux <ja...@les7arts.com>
> wrote:
> >> Hi,
> >>
> >> With Git IMO it's convenient (more information) to have the Jira number
> in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
> >>
> >> If nobody disagree I'd like to modify
> >>
> >>
> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
> >>
> >> We could have
> >>
> >> ----
> >>
> >> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
> [Jira title | Free text] [(OFBIZ-xxxx)]
> >>
> >> [(OFBIZ-xxxx)]
> >>
> >> [More detailed explanation of what has been done and what the fix
> achieves,
> >> sideeffects etc.]
> >>
> >> [Thanks:] [xxxx for ... and yyyy for]
> >>
> >> ----
> >>
> >> But I would prefer:
> >> ----
> >> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
> [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]
> >>
> >> ----
> >> Opinions?
> >>
> >> Thanks
> >>
> >> Jacques
> >>
> >>
>
Re: Modify OFBiz commit message template
Posted by Jacques Le Roux <ja...@les7arts.com>.
Thanks All,
I'll do that in 5 days, simple, efficient in Git.
Jacques
Le 20/05/2020 à 16:43, James Yong a écrit :
> +1 to
>
> ----
> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
> ----
>
> Regards,
> James
>
>
> On 2020/05/20 09:01:45, Jacques Le Roux <ja...@les7arts.com> wrote:
>> Hi,
>>
>> With Git IMO it's convenient (more information) to have the Jira number in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
>>
>> If nobody disagree I'd like to modify
>>
>> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>>
>> We could have
>>
>> ----
>>
>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [Jira title | Free text] [(OFBIZ-xxxx)]
>>
>> [(OFBIZ-xxxx)]
>>
>> [More detailed explanation of what has been done and what the fix achieves,
>> sideeffects etc.]
>>
>> [Thanks:] [xxxx for ... and yyyy for]
>>
>> ----
>>
>> But I would prefer:
>> ----
>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
>>
>> ----
>> Opinions?
>>
>> Thanks
>>
>> Jacques
>>
>>
Re: Modify OFBiz commit message template
Posted by James Yong <ja...@apache.org>.
+1 to
----
[Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
----
Regards,
James
On 2020/05/20 09:01:45, Jacques Le Roux <ja...@les7arts.com> wrote:
> Hi,
>
> With Git IMO it's convenient (more information) to have the Jira number in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
>
> If nobody disagree I'd like to modify
>
> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>
> We could have
>
> ----
>
> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [Jira title | Free text] [(OFBIZ-xxxx)]
>
> [(OFBIZ-xxxx)]
>
> [More detailed explanation of what has been done and what the fix achieves,
> sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
>
> ----
>
> But I would prefer:
> ----
> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
>
> ----
> Opinions?
>
> Thanks
>
> Jacques
>
>
Re: Modify OFBiz commit message template
Posted by Pierre Smits <pi...@apache.org>.
Can GitHub be configured that when a ticket Id is present it is shown as a
link to the ticket in Jira. IIRC I have seen it happening.
Met vriendelijke groet,
Pierre Smits
*Proud* *contributor** of* Apache OFBiz <https://ofbiz.apache.org/> since
2008 (without privileges)
*Apache Trafodion <https://trafodion.apache.org>, Vice President*
*Apache Directory <https://directory.apache.org>, PMC Member*
Apache Incubator <https://incubator.apache.org>, committer
Apache Steve <https://steve.apache.org>, committer
On Wed, May 20, 2020 at 11:36 AM Pierre Smits <pi...@apache.org>
wrote:
> The subject can be quite lengthy (as I have experienced a few times when
> doing PRs). I suggest to moving the ticket Id to the front of the first
> line.
> Also, whatever the categorisation is ([Implemented | Improved | Fixed |
> Completed| Documented | Reverted]: this should be referenced (at least) in
> the ticket.
>
> While having everything significant (like the categorisation) on the first
> line is desirable, the minimum is the ticket ID.
>
> I don't mind (people) to click through to the ticket to get a better
> understanding.
>
> What are best practices from other (Apache/Open Source) projects?
>
> Met vriendelijke groet,
>
> Pierre Smits
> *Proud* *contributor** of* Apache OFBiz <https://ofbiz.apache.org/> since
> 2008 (without privileges)
>
> *Apache Trafodion <https://trafodion.apache.org>, Vice President*
> *Apache Directory <https://directory.apache.org>, PMC Member*
> Apache Incubator <https://incubator.apache.org>, committer
> Apache Steve <https://steve.apache.org>, committer
>
>
> On Wed, May 20, 2020 at 11:03 AM Jacques Le Roux <
> jacques.le.roux@les7arts.com> wrote:
>
>> Hi,
>>
>> With Git IMO it's convenient (more information) to have the Jira number
>> in the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
>>
>> If nobody disagree I'd like to modify
>>
>>
>> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>>
>> We could have
>>
>> ----
>>
>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
>> [Jira title | Free text] [(OFBIZ-xxxx)]
>>
>> [(OFBIZ-xxxx)]
>>
>> [More detailed explanation of what has been done and what the fix
>> achieves,
>> sideeffects etc.]
>>
>> [Thanks:] [xxxx for ... and yyyy for]
>>
>> ----
>>
>> But I would prefer:
>> ----
>> [Implemented | Improved | Fixed | Completed| Documented | Reverted]:
>> [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]
>>
>> ----
>> Opinions?
>>
>> Thanks
>>
>> Jacques
>>
>>
Re: Modify OFBiz commit message template
Posted by Benjamin Jugl <be...@ecomify.de>.
Hello everyone,
Am 20.05.20 um 11:36 schrieb Pierre Smits:
> The subject can be quite lengthy (as I have experienced a few times when
> doing PRs). I suggest to moving the ticket Id to the front of the first
> line.
> Also, whatever the categorisation is ([Implemented | Improved | Fixed |
> Completed| Documented | Reverted]: this should be referenced (at least) in
> the ticket.
>
> While having everything significant (like the categorisation) on the first
> line is desirable, the minimum is the ticket ID.
I concur.
>
> I don't mind (people) to click through to the ticket to get a better
> understanding.
I used to edit the commit messages for the publication on the blog a
while ago.
Having to click through all tickets to get a better understanding is not
much fun. Even with the status quo it has to be done sometimes.
Although I cherish the learning that can take place by diving into
resolved issues it is quite timeconsuming and cumbersome.
I like the "Thanks" even though it is not technically needed, it is
always nice to read it.
Re: Modify OFBiz commit message template
Posted by Pierre Smits <pi...@apache.org>.
The subject can be quite lengthy (as I have experienced a few times when
doing PRs). I suggest to moving the ticket Id to the front of the first
line.
Also, whatever the categorisation is ([Implemented | Improved | Fixed |
Completed| Documented | Reverted]: this should be referenced (at least) in
the ticket.
While having everything significant (like the categorisation) on the first
line is desirable, the minimum is the ticket ID.
I don't mind (people) to click through to the ticket to get a better
understanding.
What are best practices from other (Apache/Open Source) projects?
Met vriendelijke groet,
Pierre Smits
*Proud* *contributor** of* Apache OFBiz <https://ofbiz.apache.org/> since
2008 (without privileges)
*Apache Trafodion <https://trafodion.apache.org>, Vice President*
*Apache Directory <https://directory.apache.org>, PMC Member*
Apache Incubator <https://incubator.apache.org>, committer
Apache Steve <https://steve.apache.org>, committer
On Wed, May 20, 2020 at 11:03 AM Jacques Le Roux <
jacques.le.roux@les7arts.com> wrote:
> Hi,
>
> With Git IMO it's convenient (more information) to have the Jira number in
> the title, eg: https://markmail.org/message/cyslglyoh5gf7l7t
>
> If nobody disagree I'd like to modify
>
>
> https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+commit+message+template
>
> We could have
>
> ----
>
> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [Jira
> title | Free text] [(OFBIZ-xxxx)]
>
> [(OFBIZ-xxxx)]
>
> [More detailed explanation of what has been done and what the fix achieves,
> sideeffects etc.]
>
> [Thanks:] [xxxx for ... and yyyy for]
>
> ----
>
> But I would prefer:
> ----
> [Implemented | Improved | Fixed | Completed| Documented | Reverted]: [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]
>
> ----
> Opinions?
>
> Thanks
>
> Jacques
>
>