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 2016/09/22 07:36:10 UTC
Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Jacopo,
I saw you answered on Confluence where I 1st asked
https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+commit+message+template?focusedCommentId=65871637#comment-65871637
Now, I understand that we need to pick a word, but why not being more flexible, similarly at what does GitHub
https://help.github.com/articles/closing-issues-via-commit-messages/ ?
I already suggested in previous threads that I could help if the process Michael uses to create the blog monthly report needs to be adapted.
In relation, I also created in the "Wiki page for the "monthly Jira issues list" creation in the blog" thread, without any answers so far :/
Thanks
Jacques
Le 22/09/2016 � 08:45, Jacques Le Roux a �crit :
> Hi Jacopo,
>
> What is the logical behind this? It's not the first time I ask and I'd really like to have a clarification.
>
> We have "Fix for" and "Documentation". Why not "Fixed" and "Documented"?
>
> Thanks
>
> Jacques
>
> Le 21/09/2016 � 19:09, Jacopo Cappellato a �crit :
>> I have changed it to "Reverted" for consistency reasons.
>>
>> Jacopo
>>
>>
>>
>> On Wed, Sep 21, 2016 at 7:01 PM, Jacques Le Roux <
>> jacques.le.roux@les7arts.com> wrote:
>>
>>> Done
>>>
>>> Jacques
>>>
>>>
>>> Le 18/09/2016 � 11:19, Jacques Le Roux a �crit :
>>>
>>>> Hi,
>>>>
>>>> In some cases we need to revert a commit done for a Jira after we
>>>> discover it causes an issue. We have not yet other means that using the fix
>>>> word.
>>>> I suggest we put in the "Reverts" (or "Revert for" or "Reverted" as it
>>>> please you) word in the commit template for this reason.
>>>> Because it's a different thing than really fixing the initial issue
>>>> reported in the Jira but it's sill related to it
>>>>
>>>> What do you think?
>>>>
>>>> Jacques
>>>>
>>>>
>>>>
>
>
Re: Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Posted by Jacques Le Roux <ja...@les7arts.com>.
Michael,
Thanks for calling the conversation stupid, you could have refrained on this :/
For the rest I'm done, I tried to put a bit more of flexibility in this template, but since nobody cares (apart Rupert, thanks!), let it be. Now you
ALL must comply...
-0 (minus zero)
Jacques
Le 22/09/2016 � 18:06, Michael Brohl a �crit :
> Hi Rupert, Jacques, all,
>
> if I search Google for it, I find many different opinions. For example, here is a viarant from the Git documentation
> http://git.kernel.org/?p=git/git.git;a=blob;f=Documentation/SubmittingPatches;h=ece3c77482b3ff006b973f1ed90b708e26556862;hb=HEAD
>
> "the body should provide a meaningful commit message, which:
> - uses the imperative, present tense: "change", not "changed" or "changes"."
>
> All in all, we simply want to achieve something UNIFIED and Jacques is still the only one objecting to use the proposed format. Noone else did.
>
> But if we can't agree on past/present or whatever tense, I have a different proposal which might be acceptable by all and end this stupid discussion:
>
> What if we state what this issue is or covers: a Bug, an Improvement, a Documentation etc.?
>
> The template then would look like:
>
> ===
>
> [Implementation|Improvement|Bug|Task|Documentation|Revert]: [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]
>
> ===
>
> I would be happy to change to this format if we can all agree to use the same without exceptions.
>
> I really wish to end this and appreciate your benevolent consideration.
>
> Thanks,
>
> Michael
>
>
> Am 22.09.16 um 17:21 schrieb Rupert Howell:
>> Hi yes, reading with interest, I agree with Jacques.
>> Commit messages should be Present Tense Imperative, Imperative Style.
>> There's plenty of links on Google as to why this is the widely adopted
>> industry standard.
>>
>> On 22 September 2016 at 16:06, Jacques Le Roux <jacques.le.roux@les7arts.com
>>> wrote:
>>> Scott,
>>>
>>> Reading your message I guess you did not read my previous explanation on
>>> why I prefer to use present instead of past. You may find more details in
>>> digging in previous emails.
>>>
>>> But long story short, I'm French so I can't compete in English with
>>> someone like you for who English is the mother tongue.
>>>
>>> The reason I use present is because I got this habit while working with
>>> Rupert Howell. You know, the guy who wrote the first OFBiz book. I don't
>>> reveal anything saying he is from Southampton (at least he lives there). I
>>> was then used to use past also in commit messages. A habit I got while
>>> seeing others committing in OFBiz. But when I saw Rupert using present, it
>>> immediately made sense to me: at the moment you commit, you are doing an
>>> action. So I should use present, I'm doing the commit, it's not yet done.
>>>
>>> I don't know if Rupert will read or appreciate this message, but it's the
>>> truth!
>>>
>>> Anyway I believe it's a moot point, and we should have the freedom to
>>> write as we prefer, like it's done in a successful project like GitHub...
>>>
>>> Jacques
>>>
>>>
>>> Le 22/09/2016 � 14:52, Scott Gray a �crit :
>>>
>>>> I can't believe you're being so stubborn about something so minor Jacques,
>>>> it seems like very strange behavior to me. For what it's worth as a
>>>> native
>>>> English speaker, reading a commit message written in present-tense feels
>>>> very strange to me. I'm looking at a history and reading something as
>>>> though it is current, it doesn't feel logical.
>>>>
>>>> Regards
>>>> Scott
>>>>
>>>> On 22 September 2016 at 19:36, Jacques Le Roux <
>>>> jacques.le.roux@les7arts.com
>>>>
>>>>> wrote:
>>>>> Jacopo,
>>>>>
>>>>> I saw you answered on Confluence where I 1st asked
>>>>> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
>>>>> commit+message+template?focusedCommentId=65871637#comment-65871637
>>>>>
>>>>> Now, I understand that we need to pick a word, but why not being more
>>>>> flexible, similarly at what does GitHub https://help.github.com/articl
>>>>> es/closing-issues-via-commit-messages/ ?
>>>>>
>>>>> I already suggested in previous threads that I could help if the process
>>>>> Michael uses to create the blog monthly report needs to be adapted.
>>>>> In relation, I also created in the "Wiki page for the "monthly Jira
>>>>> issues
>>>>> list" creation in the blog" thread, without any answers so far :/
>>>>>
>>>>> Thanks
>>>>>
>>>>> Jacques
>>>>>
>>>>>
>>>>> Le 22/09/2016 � 08:45, Jacques Le Roux a �crit :
>>>>>
>>>>> Hi Jacopo,
>>>>>> What is the logical behind this? It's not the first time I ask and I'd
>>>>>> really like to have a clarification.
>>>>>>
>>>>>> We have "Fix for" and "Documentation". Why not "Fixed" and "Documented"?
>>>>>>
>>>>>> Thanks
>>>>>>
>>>>>> Jacques
>>>>>>
>>>>>> Le 21/09/2016 � 19:09, Jacopo Cappellato a �crit :
>>>>>>
>>>>>> I have changed it to "Reverted" for consistency reasons.
>>>>>>> Jacopo
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> On Wed, Sep 21, 2016 at 7:01 PM, Jacques Le Roux <
>>>>>>> jacques.le.roux@les7arts.com> wrote:
>>>>>>>
>>>>>>> Done
>>>>>>>
>>>>>>>> Jacques
>>>>>>>>
>>>>>>>>
>>>>>>>> Le 18/09/2016 � 11:19, Jacques Le Roux a �crit :
>>>>>>>>
>>>>>>>> Hi,
>>>>>>>>
>>>>>>>>> In some cases we need to revert a commit done for a Jira after we
>>>>>>>>> discover it causes an issue. We have not yet other means that using
>>>>>>>>> the fix
>>>>>>>>> word.
>>>>>>>>> I suggest we put in the "Reverts" (or "Revert for" or "Reverted" as
>>>>>>>>> it
>>>>>>>>> please you) word in the commit template for this reason.
>>>>>>>>> Because it's a different thing than really fixing the initial issue
>>>>>>>>> reported in the Jira but it's sill related to it
>>>>>>>>>
>>>>>>>>> What do you think?
>>>>>>>>>
>>>>>>>>> Jacques
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>
>
>
Re: Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Posted by Jacques Le Roux <ja...@les7arts.com>.
Le 22/09/2016 � 18:06, Michael Brohl a �crit :
> Hi Rupert, Jacques, all,
>
> if I search Google for it, I find many different opinions. For example, here is a viarant from the Git documentation
> http://git.kernel.org/?p=git/git.git;a=blob;f=Documentation/SubmittingPatches;h=ece3c77482b3ff006b973f1ed90b708e26556862;hb=HEAD
Just to add that it's why I suggested to use verbs variations, like do GitHub. To allow users to use the one they prefer, but
>
> "the body should provide a meaningful commit message, which:
> - uses the imperative, present tense: "change", not "changed" or "changes"."
>
> All in all, we simply want to achieve something UNIFIED and Jacques is still the only one objecting to use the proposed format. Noone else did.
>
> But if we can't agree on past/present or whatever tense, I have a different proposal which might be acceptable by all and end this stupid discussion:
>
> What if we state what this issue is or covers: a Bug, an Improvement, a Documentation etc.?
>
> The template then would look like:
>
> ===
>
> [Implementation|Improvement|Bug|Task|Documentation|Revert]: [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]
>
> ===
>
> I would be happy to change to this format if we can all agree to use the same without exceptions.
Revert then should be Reversion: http://www.etymonline.com/index.php?term=reversion
Jacques
>
> I really wish to end this and appreciate your benevolent consideration.
>
> Thanks,
>
> Michael
>
>
> Am 22.09.16 um 17:21 schrieb Rupert Howell:
>> Hi yes, reading with interest, I agree with Jacques.
>> Commit messages should be Present Tense Imperative, Imperative Style.
>> There's plenty of links on Google as to why this is the widely adopted
>> industry standard.
>>
>> On 22 September 2016 at 16:06, Jacques Le Roux <jacques.le.roux@les7arts.com
>>> wrote:
>>> Scott,
>>>
>>> Reading your message I guess you did not read my previous explanation on
>>> why I prefer to use present instead of past. You may find more details in
>>> digging in previous emails.
>>>
>>> But long story short, I'm French so I can't compete in English with
>>> someone like you for who English is the mother tongue.
>>>
>>> The reason I use present is because I got this habit while working with
>>> Rupert Howell. You know, the guy who wrote the first OFBiz book. I don't
>>> reveal anything saying he is from Southampton (at least he lives there). I
>>> was then used to use past also in commit messages. A habit I got while
>>> seeing others committing in OFBiz. But when I saw Rupert using present, it
>>> immediately made sense to me: at the moment you commit, you are doing an
>>> action. So I should use present, I'm doing the commit, it's not yet done.
>>>
>>> I don't know if Rupert will read or appreciate this message, but it's the
>>> truth!
>>>
>>> Anyway I believe it's a moot point, and we should have the freedom to
>>> write as we prefer, like it's done in a successful project like GitHub...
>>>
>>> Jacques
>>>
>>>
>>> Le 22/09/2016 � 14:52, Scott Gray a �crit :
>>>
>>>> I can't believe you're being so stubborn about something so minor Jacques,
>>>> it seems like very strange behavior to me. For what it's worth as a
>>>> native
>>>> English speaker, reading a commit message written in present-tense feels
>>>> very strange to me. I'm looking at a history and reading something as
>>>> though it is current, it doesn't feel logical.
>>>>
>>>> Regards
>>>> Scott
>>>>
>>>> On 22 September 2016 at 19:36, Jacques Le Roux <
>>>> jacques.le.roux@les7arts.com
>>>>
>>>>> wrote:
>>>>> Jacopo,
>>>>>
>>>>> I saw you answered on Confluence where I 1st asked
>>>>> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
>>>>> commit+message+template?focusedCommentId=65871637#comment-65871637
>>>>>
>>>>> Now, I understand that we need to pick a word, but why not being more
>>>>> flexible, similarly at what does GitHub https://help.github.com/articl
>>>>> es/closing-issues-via-commit-messages/ ?
>>>>>
>>>>> I already suggested in previous threads that I could help if the process
>>>>> Michael uses to create the blog monthly report needs to be adapted.
>>>>> In relation, I also created in the "Wiki page for the "monthly Jira
>>>>> issues
>>>>> list" creation in the blog" thread, without any answers so far :/
>>>>>
>>>>> Thanks
>>>>>
>>>>> Jacques
>>>>>
>>>>>
>>>>> Le 22/09/2016 � 08:45, Jacques Le Roux a �crit :
>>>>>
>>>>> Hi Jacopo,
>>>>>> What is the logical behind this? It's not the first time I ask and I'd
>>>>>> really like to have a clarification.
>>>>>>
>>>>>> We have "Fix for" and "Documentation". Why not "Fixed" and "Documented"?
>>>>>>
>>>>>> Thanks
>>>>>>
>>>>>> Jacques
>>>>>>
>>>>>> Le 21/09/2016 � 19:09, Jacopo Cappellato a �crit :
>>>>>>
>>>>>> I have changed it to "Reverted" for consistency reasons.
>>>>>>> Jacopo
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>> On Wed, Sep 21, 2016 at 7:01 PM, Jacques Le Roux <
>>>>>>> jacques.le.roux@les7arts.com> wrote:
>>>>>>>
>>>>>>> Done
>>>>>>>
>>>>>>>> Jacques
>>>>>>>>
>>>>>>>>
>>>>>>>> Le 18/09/2016 � 11:19, Jacques Le Roux a �crit :
>>>>>>>>
>>>>>>>> Hi,
>>>>>>>>
>>>>>>>>> In some cases we need to revert a commit done for a Jira after we
>>>>>>>>> discover it causes an issue. We have not yet other means that using
>>>>>>>>> the fix
>>>>>>>>> word.
>>>>>>>>> I suggest we put in the "Reverts" (or "Revert for" or "Reverted" as
>>>>>>>>> it
>>>>>>>>> please you) word in the commit template for this reason.
>>>>>>>>> Because it's a different thing than really fixing the initial issue
>>>>>>>>> reported in the Jira but it's sill related to it
>>>>>>>>>
>>>>>>>>> What do you think?
>>>>>>>>>
>>>>>>>>> Jacques
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>>>>>>>>
>>
>
>
Re: Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Posted by Michael Brohl <mi...@ecomify.de>.
Hi Rupert, Jacques, all,
if I search Google for it, I find many different opinions. For example,
here is a viarant from the Git documentation
http://git.kernel.org/?p=git/git.git;a=blob;f=Documentation/SubmittingPatches;h=ece3c77482b3ff006b973f1ed90b708e26556862;hb=HEAD
"the body should provide a meaningful commit message, which:
- uses the imperative, present tense: "change", not "changed" or "changes"."
All in all, we simply want to achieve something UNIFIED and Jacques is
still the only one objecting to use the proposed format. Noone else did.
But if we can't agree on past/present or whatever tense, I have a
different proposal which might be acceptable by all and end this stupid
discussion:
What if we state what this issue is or covers: a Bug, an Improvement, a
Documentation etc.?
The template then would look like:
===
[Implementation|Improvement|Bug|Task|Documentation|Revert]: [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]
===
I would be happy to change to this format if we can all agree to use the
same without exceptions.
I really wish to end this and appreciate your benevolent consideration.
Thanks,
Michael
Am 22.09.16 um 17:21 schrieb Rupert Howell:
> Hi yes, reading with interest, I agree with Jacques.
> Commit messages should be Present Tense Imperative, Imperative Style.
> There's plenty of links on Google as to why this is the widely adopted
> industry standard.
>
> On 22 September 2016 at 16:06, Jacques Le Roux <jacques.le.roux@les7arts.com
>> wrote:
>> Scott,
>>
>> Reading your message I guess you did not read my previous explanation on
>> why I prefer to use present instead of past. You may find more details in
>> digging in previous emails.
>>
>> But long story short, I'm French so I can't compete in English with
>> someone like you for who English is the mother tongue.
>>
>> The reason I use present is because I got this habit while working with
>> Rupert Howell. You know, the guy who wrote the first OFBiz book. I don't
>> reveal anything saying he is from Southampton (at least he lives there). I
>> was then used to use past also in commit messages. A habit I got while
>> seeing others committing in OFBiz. But when I saw Rupert using present, it
>> immediately made sense to me: at the moment you commit, you are doing an
>> action. So I should use present, I'm doing the commit, it's not yet done.
>>
>> I don't know if Rupert will read or appreciate this message, but it's the
>> truth!
>>
>> Anyway I believe it's a moot point, and we should have the freedom to
>> write as we prefer, like it's done in a successful project like GitHub...
>>
>> Jacques
>>
>>
>> Le 22/09/2016 à 14:52, Scott Gray a écrit :
>>
>>> I can't believe you're being so stubborn about something so minor Jacques,
>>> it seems like very strange behavior to me. For what it's worth as a
>>> native
>>> English speaker, reading a commit message written in present-tense feels
>>> very strange to me. I'm looking at a history and reading something as
>>> though it is current, it doesn't feel logical.
>>>
>>> Regards
>>> Scott
>>>
>>> On 22 September 2016 at 19:36, Jacques Le Roux <
>>> jacques.le.roux@les7arts.com
>>>
>>>> wrote:
>>>> Jacopo,
>>>>
>>>> I saw you answered on Confluence where I 1st asked
>>>> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
>>>> commit+message+template?focusedCommentId=65871637#comment-65871637
>>>>
>>>> Now, I understand that we need to pick a word, but why not being more
>>>> flexible, similarly at what does GitHub https://help.github.com/articl
>>>> es/closing-issues-via-commit-messages/ ?
>>>>
>>>> I already suggested in previous threads that I could help if the process
>>>> Michael uses to create the blog monthly report needs to be adapted.
>>>> In relation, I also created in the "Wiki page for the "monthly Jira
>>>> issues
>>>> list" creation in the blog" thread, without any answers so far :/
>>>>
>>>> Thanks
>>>>
>>>> Jacques
>>>>
>>>>
>>>> Le 22/09/2016 à 08:45, Jacques Le Roux a écrit :
>>>>
>>>> Hi Jacopo,
>>>>> What is the logical behind this? It's not the first time I ask and I'd
>>>>> really like to have a clarification.
>>>>>
>>>>> We have "Fix for" and "Documentation". Why not "Fixed" and "Documented"?
>>>>>
>>>>> Thanks
>>>>>
>>>>> Jacques
>>>>>
>>>>> Le 21/09/2016 à 19:09, Jacopo Cappellato a écrit :
>>>>>
>>>>> I have changed it to "Reverted" for consistency reasons.
>>>>>> Jacopo
>>>>>>
>>>>>>
>>>>>>
>>>>>> On Wed, Sep 21, 2016 at 7:01 PM, Jacques Le Roux <
>>>>>> jacques.le.roux@les7arts.com> wrote:
>>>>>>
>>>>>> Done
>>>>>>
>>>>>>> Jacques
>>>>>>>
>>>>>>>
>>>>>>> Le 18/09/2016 à 11:19, Jacques Le Roux a écrit :
>>>>>>>
>>>>>>> Hi,
>>>>>>>
>>>>>>>> In some cases we need to revert a commit done for a Jira after we
>>>>>>>> discover it causes an issue. We have not yet other means that using
>>>>>>>> the fix
>>>>>>>> word.
>>>>>>>> I suggest we put in the "Reverts" (or "Revert for" or "Reverted" as
>>>>>>>> it
>>>>>>>> please you) word in the commit template for this reason.
>>>>>>>> Because it's a different thing than really fixing the initial issue
>>>>>>>> reported in the Jira but it's sill related to it
>>>>>>>>
>>>>>>>> What do you think?
>>>>>>>>
>>>>>>>> Jacques
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>>>>>>>>
>
Re: Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Posted by Pierre Smits <pi...@gmail.com>.
Yes, you have to give to get. In this case give up the viewpoint and get
the compromise. Unfortunately, that goes for *everybody*, not just the one,
as a compromise is something everybody can live with. If only viewpoints
are brought forward, the only thing we can say is: 'we agree to disagree'.
Which is also a satisfactory outcome for that moment.
On a related subject: Jacques has asked Michael to share the procedure to
be put in a wiki page, so that the burden doesn't rely on 1 contributor.
There seem to be no response to that question.
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 24, 2016 at 2:38 PM, Sharan Foga <sh...@gmail.com> wrote:
> Hi All
>
> The initiative to setup a unified commit message was to help reduce the
> workload Michael has to do each month to compile the blog.
>
> We are a community and we want to work together and help each other. All
> the time we try very hard to reach consensus but sometimes that isn't
> possible, so someone has to be willing to compromise, or we take a vote and
> that is the way progress is made.
>
> I can see no compromise happening here at all, instead I see a lot of
> effort defending a single position and people getting frustrated on both
> sides. A community functions by raising proposals and building consensus.
> That means it is about convincing others, not everyone, but the majority
> that the proposal has merit, and Michael has successfully done that in
> this case.
>
> I think that if Jacques is not willing to compromise then I suspect that a
> formal vote will settle it. Ideally we shouldn't have to go to those
> extremes over a single word.
>
> Thanks
> Sharan
>
>
> On 2016-09-22 19:28 (+0200), Jacopo Cappellato <jacopo.cappellato@
> hotwaxsystems.com> wrote:
> > On Thu, Sep 22, 2016 at 5:21 PM, Rupert Howell <
> ruperthowell@provolve.com>
> > wrote:
> >
> > > Hi yes, reading with interest, I agree with Jacques.
> > > Commit messages should be Present Tense Imperative, Imperative Style.
> > >
> >
> > well, now I am a bit confused because Jacques is using Present Tense in
> > Third Person ("fixes") and not the Imperative Style ("fix")... but now I
> am
> > walking on the thin ice since English is not my mother tongue! From what
> I
> > understand the "present tense imperative" is the suggested style for Git
> > repositories... and this reminds me that we should start talking about
> > migrating from Svn to Git :-)
> >
> > Jacopo
> >
> > PS: Welcome back Rupert!
> >
>
Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
Posted by Sharan Foga <sh...@gmail.com>.
Hi All
The initiative to setup a unified commit message was to help reduce the workload Michael has to do each month to compile the blog.
We are a community and we want to work together and help each other. All the time we try very hard to reach consensus but sometimes that isn't possible, so someone has to be willing to compromise, or we take a vote and that is the way progress is made.
I can see no compromise happening here at all, instead I see a lot of effort defending a single position and people getting frustrated on both sides. A community functions by raising proposals and building consensus. That means it is about convincing others, not everyone, but the majority that the proposal has merit, and Michael has successfully done that in this case.
I think that if Jacques is not willing to compromise then I suspect that a formal vote will settle it. Ideally we shouldn't have to go to those extremes over a single word.
Thanks
Sharan
On 2016-09-22 19:28 (+0200), Jacopo Cappellato <ja...@hotwaxsystems.com> wrote:
> On Thu, Sep 22, 2016 at 5:21 PM, Rupert Howell <ru...@provolve.com>
> wrote:
>
> > Hi yes, reading with interest, I agree with Jacques.
> > Commit messages should be Present Tense Imperative, Imperative Style.
> >
>
> well, now I am a bit confused because Jacques is using Present Tense in
> Third Person ("fixes") and not the Imperative Style ("fix")... but now I am
> walking on the thin ice since English is not my mother tongue! From what I
> understand the "present tense imperative" is the suggested style for Git
> repositories... and this reminds me that we should start talking about
> migrating from Svn to Git :-)
>
> Jacopo
>
> PS: Welcome back Rupert!
>
Re: Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Posted by Jacopo Cappellato <ja...@hotwaxsystems.com>.
On Thu, Sep 22, 2016 at 5:21 PM, Rupert Howell <ru...@provolve.com>
wrote:
> Hi yes, reading with interest, I agree with Jacques.
> Commit messages should be Present Tense Imperative, Imperative Style.
>
well, now I am a bit confused because Jacques is using Present Tense in
Third Person ("fixes") and not the Imperative Style ("fix")... but now I am
walking on the thin ice since English is not my mother tongue! From what I
understand the "present tense imperative" is the suggested style for Git
repositories... and this reminds me that we should start talking about
migrating from Svn to Git :-)
Jacopo
PS: Welcome back Rupert!
Re: Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Posted by Rupert Howell <ru...@provolve.com>.
Hi yes, reading with interest, I agree with Jacques.
Commit messages should be Present Tense Imperative, Imperative Style.
There's plenty of links on Google as to why this is the widely adopted
industry standard.
On 22 September 2016 at 16:06, Jacques Le Roux <jacques.le.roux@les7arts.com
> wrote:
> Scott,
>
> Reading your message I guess you did not read my previous explanation on
> why I prefer to use present instead of past. You may find more details in
> digging in previous emails.
>
> But long story short, I'm French so I can't compete in English with
> someone like you for who English is the mother tongue.
>
> The reason I use present is because I got this habit while working with
> Rupert Howell. You know, the guy who wrote the first OFBiz book. I don't
> reveal anything saying he is from Southampton (at least he lives there). I
> was then used to use past also in commit messages. A habit I got while
> seeing others committing in OFBiz. But when I saw Rupert using present, it
> immediately made sense to me: at the moment you commit, you are doing an
> action. So I should use present, I'm doing the commit, it's not yet done.
>
> I don't know if Rupert will read or appreciate this message, but it's the
> truth!
>
> Anyway I believe it's a moot point, and we should have the freedom to
> write as we prefer, like it's done in a successful project like GitHub...
>
> Jacques
>
>
> Le 22/09/2016 à 14:52, Scott Gray a écrit :
>
>> I can't believe you're being so stubborn about something so minor Jacques,
>> it seems like very strange behavior to me. For what it's worth as a
>> native
>> English speaker, reading a commit message written in present-tense feels
>> very strange to me. I'm looking at a history and reading something as
>> though it is current, it doesn't feel logical.
>>
>> Regards
>> Scott
>>
>> On 22 September 2016 at 19:36, Jacques Le Roux <
>> jacques.le.roux@les7arts.com
>>
>>> wrote:
>>> Jacopo,
>>>
>>> I saw you answered on Confluence where I 1st asked
>>> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
>>> commit+message+template?focusedCommentId=65871637#comment-65871637
>>>
>>> Now, I understand that we need to pick a word, but why not being more
>>> flexible, similarly at what does GitHub https://help.github.com/articl
>>> es/closing-issues-via-commit-messages/ ?
>>>
>>> I already suggested in previous threads that I could help if the process
>>> Michael uses to create the blog monthly report needs to be adapted.
>>> In relation, I also created in the "Wiki page for the "monthly Jira
>>> issues
>>> list" creation in the blog" thread, without any answers so far :/
>>>
>>> Thanks
>>>
>>> Jacques
>>>
>>>
>>> Le 22/09/2016 à 08:45, Jacques Le Roux a écrit :
>>>
>>> Hi Jacopo,
>>>>
>>>> What is the logical behind this? It's not the first time I ask and I'd
>>>> really like to have a clarification.
>>>>
>>>> We have "Fix for" and "Documentation". Why not "Fixed" and "Documented"?
>>>>
>>>> Thanks
>>>>
>>>> Jacques
>>>>
>>>> Le 21/09/2016 à 19:09, Jacopo Cappellato a écrit :
>>>>
>>>> I have changed it to "Reverted" for consistency reasons.
>>>>>
>>>>> Jacopo
>>>>>
>>>>>
>>>>>
>>>>> On Wed, Sep 21, 2016 at 7:01 PM, Jacques Le Roux <
>>>>> jacques.le.roux@les7arts.com> wrote:
>>>>>
>>>>> Done
>>>>>
>>>>>> Jacques
>>>>>>
>>>>>>
>>>>>> Le 18/09/2016 à 11:19, Jacques Le Roux a écrit :
>>>>>>
>>>>>> Hi,
>>>>>>
>>>>>>> In some cases we need to revert a commit done for a Jira after we
>>>>>>> discover it causes an issue. We have not yet other means that using
>>>>>>> the fix
>>>>>>> word.
>>>>>>> I suggest we put in the "Reverts" (or "Revert for" or "Reverted" as
>>>>>>> it
>>>>>>> please you) word in the commit template for this reason.
>>>>>>> Because it's a different thing than really fixing the initial issue
>>>>>>> reported in the Jira but it's sill related to it
>>>>>>>
>>>>>>> What do you think?
>>>>>>>
>>>>>>> Jacques
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>>>>
>
--
Rupert Howell
Provolve Ltd
Front Office, Deale House, 16 Lavant Street, Petersfield, GU32 3EW, UK
t: 01730 267868 / m: 079 0968 5308
e: ruperthowell@provolve.com
w: http://www.provolve.com
Re: Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Posted by Jacques Le Roux <ja...@les7arts.com>.
Scott,
Reading your message I guess you did not read my previous explanation on why I prefer to use present instead of past. You may find more details in
digging in previous emails.
But long story short, I'm French so I can't compete in English with someone like you for who English is the mother tongue.
The reason I use present is because I got this habit while working with Rupert Howell. You know, the guy who wrote the first OFBiz book. I don't
reveal anything saying he is from Southampton (at least he lives there). I was then used to use past also in commit messages. A habit I got while
seeing others committing in OFBiz. But when I saw Rupert using present, it immediately made sense to me: at the moment you commit, you are doing an
action. So I should use present, I'm doing the commit, it's not yet done.
I don't know if Rupert will read or appreciate this message, but it's the truth!
Anyway I believe it's a moot point, and we should have the freedom to write as we prefer, like it's done in a successful project like GitHub...
Jacques
Le 22/09/2016 � 14:52, Scott Gray a �crit :
> I can't believe you're being so stubborn about something so minor Jacques,
> it seems like very strange behavior to me. For what it's worth as a native
> English speaker, reading a commit message written in present-tense feels
> very strange to me. I'm looking at a history and reading something as
> though it is current, it doesn't feel logical.
>
> Regards
> Scott
>
> On 22 September 2016 at 19:36, Jacques Le Roux <jacques.le.roux@les7arts.com
>> wrote:
>> Jacopo,
>>
>> I saw you answered on Confluence where I 1st asked
>> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
>> commit+message+template?focusedCommentId=65871637#comment-65871637
>>
>> Now, I understand that we need to pick a word, but why not being more
>> flexible, similarly at what does GitHub https://help.github.com/articl
>> es/closing-issues-via-commit-messages/ ?
>>
>> I already suggested in previous threads that I could help if the process
>> Michael uses to create the blog monthly report needs to be adapted.
>> In relation, I also created in the "Wiki page for the "monthly Jira issues
>> list" creation in the blog" thread, without any answers so far :/
>>
>> Thanks
>>
>> Jacques
>>
>>
>> Le 22/09/2016 � 08:45, Jacques Le Roux a �crit :
>>
>>> Hi Jacopo,
>>>
>>> What is the logical behind this? It's not the first time I ask and I'd
>>> really like to have a clarification.
>>>
>>> We have "Fix for" and "Documentation". Why not "Fixed" and "Documented"?
>>>
>>> Thanks
>>>
>>> Jacques
>>>
>>> Le 21/09/2016 � 19:09, Jacopo Cappellato a �crit :
>>>
>>>> I have changed it to "Reverted" for consistency reasons.
>>>>
>>>> Jacopo
>>>>
>>>>
>>>>
>>>> On Wed, Sep 21, 2016 at 7:01 PM, Jacques Le Roux <
>>>> jacques.le.roux@les7arts.com> wrote:
>>>>
>>>> Done
>>>>> Jacques
>>>>>
>>>>>
>>>>> Le 18/09/2016 � 11:19, Jacques Le Roux a �crit :
>>>>>
>>>>> Hi,
>>>>>> In some cases we need to revert a commit done for a Jira after we
>>>>>> discover it causes an issue. We have not yet other means that using
>>>>>> the fix
>>>>>> word.
>>>>>> I suggest we put in the "Reverts" (or "Revert for" or "Reverted" as it
>>>>>> please you) word in the commit template for this reason.
>>>>>> Because it's a different thing than really fixing the initial issue
>>>>>> reported in the Jira but it's sill related to it
>>>>>>
>>>>>> What do you think?
>>>>>>
>>>>>> Jacques
>>>>>>
>>>>>>
>>>>>>
>>>>>>
>>>
Re: Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Posted by Scott Gray <sc...@hotwaxsystems.com>.
I can't believe you're being so stubborn about something so minor Jacques,
it seems like very strange behavior to me. For what it's worth as a native
English speaker, reading a commit message written in present-tense feels
very strange to me. I'm looking at a history and reading something as
though it is current, it doesn't feel logical.
Regards
Scott
On 22 September 2016 at 19:36, Jacques Le Roux <jacques.le.roux@les7arts.com
> wrote:
> Jacopo,
>
> I saw you answered on Confluence where I 1st asked
> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
> commit+message+template?focusedCommentId=65871637#comment-65871637
>
> Now, I understand that we need to pick a word, but why not being more
> flexible, similarly at what does GitHub https://help.github.com/articl
> es/closing-issues-via-commit-messages/ ?
>
> I already suggested in previous threads that I could help if the process
> Michael uses to create the blog monthly report needs to be adapted.
> In relation, I also created in the "Wiki page for the "monthly Jira issues
> list" creation in the blog" thread, without any answers so far :/
>
> Thanks
>
> Jacques
>
>
> Le 22/09/2016 à 08:45, Jacques Le Roux a écrit :
>
>> Hi Jacopo,
>>
>> What is the logical behind this? It's not the first time I ask and I'd
>> really like to have a clarification.
>>
>> We have "Fix for" and "Documentation". Why not "Fixed" and "Documented"?
>>
>> Thanks
>>
>> Jacques
>>
>> Le 21/09/2016 à 19:09, Jacopo Cappellato a écrit :
>>
>>> I have changed it to "Reverted" for consistency reasons.
>>>
>>> Jacopo
>>>
>>>
>>>
>>> On Wed, Sep 21, 2016 at 7:01 PM, Jacques Le Roux <
>>> jacques.le.roux@les7arts.com> wrote:
>>>
>>> Done
>>>>
>>>> Jacques
>>>>
>>>>
>>>> Le 18/09/2016 à 11:19, Jacques Le Roux a écrit :
>>>>
>>>> Hi,
>>>>>
>>>>> In some cases we need to revert a commit done for a Jira after we
>>>>> discover it causes an issue. We have not yet other means that using
>>>>> the fix
>>>>> word.
>>>>> I suggest we put in the "Reverts" (or "Revert for" or "Reverted" as it
>>>>> please you) word in the commit template for this reason.
>>>>> Because it's a different thing than really fixing the initial issue
>>>>> reported in the Jira but it's sill related to it
>>>>>
>>>>> What do you think?
>>>>>
>>>>> Jacques
>>>>>
>>>>>
>>>>>
>>>>>
>>
>>
>
Re: Commit template, more flexibility [was Re: Put "Reverts" in the
commit template?]
Posted by Jacopo Cappellato <ja...@hotwaxsystems.com>.
On Thu, Sep 22, 2016 at 9:36 AM, Jacques Le Roux <
jacques.le.roux@les7arts.com> wrote:
> Jacopo,
>
> I saw you answered on Confluence where I 1st asked
> https://cwiki.apache.org/confluence/display/OFBADMIN/OFBiz+
> commit+message+template?focusedCommentId=65871637#comment-65871637
>
> Now, I understand that we need to pick a word, but why not being more
> flexible, similarly at what does GitHub https://help.github.com/articl
> es/closing-issues-via-commit-messages/ ?
>
>
It seems we agree with your first proposal of using "documented", "fixed",
"reverted" so I will update the Wiki now to reflect these changes; if the
other committers will object we will revisit this decision.
As regards the "flexibility" topic, in my opinion it will defeat the effort
of defining a template format: however I don't have further time to spend
on this topic at the moment so I will let others to continue it in this
thread and we will see what the outcome is.
Jacopo