Put "Reverts" in the commit template?
Locked
12
12
Put "Reverts" in the commit template?
 
Administrator
|
Re: Put "Reverts" in the commit template?
|
Administrator
|
Re: Put "Reverts" in the commit template?
|
In reply to this post by Jacques Le Roux
+1
Michael Am 18.09.16 um 11:19 schrieb Jacques Le Roux: > 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 > |
smime.p7s (5K)
Re: Put "Reverts" in the commit template?
|
Re: Put "Reverts" in the commit template?
|
Administrator
|
Re: Put "Reverts" in the commit template?
|
|
Re: Put "Reverts" in the commit template?
|
Administrator
|
Re: Put "Reverts" in the commit template?
|
|
Re: Put "Reverts" in the commit template?
|
Administrator
|
Re: Put "Reverts" in the commit template?
|
|
Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
|
Administrator
|
Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
|
|
Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
|
|
Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
|
Administrator
|
Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
|
|
Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
|
|
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 <[hidden email] >> 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 < >>> [hidden email] >>> >>>> 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 < >>>>>> [hidden email]> 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?]
|
Administrator
|
Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
|
|
Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
|
|
Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
|
Administrator
|
| Free forum by Nabble | Edit this page |