Hi Michael, Would it not be more convenient to have the JIRA issue number first? And then the rest as per your suggestion?
Best regards, Pierre Smits ORRTIZ.COM <http://www.orrtiz.com> OFBiz based solutions & services OFBiz Extensions Marketplace http://oem.ofbizci.net/oci-2/ On Tue, Sep 6, 2016 at 10:08 AM, Michael Brohl <[email protected]> wrote: > Fellow committers, > > as you might know, I'm preparing the monthly development details (mostly > related to Jiras) for our blog at https://blogs.apache.org/ofbiz/. > > This is currently a lot of manual work (expecially when we have Community > Days!) mostly because the commit messages I use as the source are not > unified and written in different formats (Jira reference at the beginning, > among the text or end, different line separators, unnecessary or doubled > informations like mentioning Jira while also giving the Jira issue etc.). > Each developer has his/her own style :-) > > I'd like to propose a more unified format (or template) for the commit > messages which we can put in the Best Practices part of our Wiki. > > My proposal for a unified format would be: > > > === > > [Applied patch for|Implemented|Improved|Fix for|Documentation]: [Jira > title|Free text] [(OFBIZ-xxxx)] > > [Details:] [More detailed explanation of what has been done and what the > fix achieves, sideeffects etc.] > > [Thanks:] [xxxx for ... and yyyy for] > > === > > > Some rules: > > * line 1 is mandatory, the following lines are optional > > * line 1: a ":" follows after the kind of implementation/source of work > > * line 1: the Jira title must not be quoted (""), the Jira reference > should be in parenthesis, no whitespace. > > * no separators between the lines, just new lines > > > This would help a lot for the preparation of the blog and would also make > the reading of the commit logs (command line and IDE) much easier, > especially when they are displayed as one-liners. > > > What do you think? > > Regards, > > Michael Brohl > ecomify GmbH > www.ecomify.de > > > >
