Put "Reverts" in the commit template?

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

Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]

Jacques Le Roux
Administrator
Hi Jinghai,

Yes you are right, something we should remember. I'll try...

Jacques


Le 23/09/2016 à 03:04, Shi Jinghai a écrit :

> Ha, English, my favorite part. When I was 10, I learned my first 2 sentences of English:
> 1. Long life Chairman Mao!
> 2. Good morning comrade ... Gray
>
> We are a worldwide community, please keep communication as simple as possible.
>
> Good morning comrade everybody,
>
> Shi Jinghai
>
> -----邮件原件-----
> 发件人: Jacques Le Roux [mailto:[hidden email]]
> 发送时间: 2016年9月22日 23:07
> 收件人: [hidden email]
> 主题: Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]
>
> 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
>>>>>>>
>>>>>>>
>>>>>>>
>>>>>>>
>
>

Reply | Threaded
Open this post in threaded view
|

Re: Put "Reverts" in the commit template?

Jacques Le Roux
Administrator
In reply to this post by Jacques Le Roux
I think I identified another token and I want to call it "Update"

At https://cwiki.apache.org/confluence/display/OFBIZ/From+Ant+to+Gradle we show the content of the main README.md file in HTML format (Confluence does
not render directly the Markdown format)

For that at the moment we (I mostly) use Pandoc locally to transform the main README.md file in HTML format. Confluence then takes care of the rest.

There is a pending task to automate that using BuildBot (OFBIZ-8057) but I the meantime I simply sometimes commit a README.md.html when updated, hence
the "Update" token proposition. It can be used also with website commits.

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
>
>

Reply | Threaded
Open this post in threaded view
|

Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]

Sharan-F
In reply to this post by Jacopo Cappellato-5
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 <[hidden email]> wrote:

> On Thu, Sep 22, 2016 at 5:21 PM, Rupert Howell <[hidden email]>
> 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!
>
Reply | Threaded
Open this post in threaded view
|

Re: Commit template, more flexibility [was Re: Put "Reverts" in the commit template?]

Pierre Smits
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 <[hidden email]> 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 <
> [hidden email]>
> > 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!
> >
>
12