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 <[email protected]>
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 <[email protected]>
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









Attachment: smime.p7s
Description: S/MIME Cryptographic Signature

Reply via email to