Le 08/09/2016 à 11:16, Jacopo Cappellato a écrit :
What about the following slightly modified template?
======================
[Implemented|Improved|Fix for|Documentation]: [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]
======================
This is the list of the minor differences/comments:
1) Removed "Applied ...": in my opinion the Thanks (for the patch) part
will cover this and they are redundant; in the thanks part we can mention
if the patch has been included with modifications (crediting also the
author of the modifications)
2) [Jira title] if it makes sense, otherwise use free text
3) use a blank line rather than "Details:": it is more natural and should
still be easy for you to split the two parts
Jacopo
I think it's a good idea to normalize our commits comments and your proposition
seems good to me Jacopo.
Now, of course I wonder about how to automate it. I can do it on my own side using TortoiseSVN and Eclipse specific features, nice. I guess the same
exist on other svn GUI clients. But could we not enforce the rule and make things automated for committers? Here is an "official" answer from the
Subversion team https://subversion.open.collab.net/ds/viewMessage.do?dsMessageId=487681&dsForumId=4 So maybe we could use that as a basis to create
our own? https://gist.github.com/alecthegeek/4134951
Last but not least: this started from Michael's need to format monthly Jira notes in our blog (kudos for the work Michael!). It will certainly be
easier for Michael to have this in place. But you might have noticed that I asked a question to Atlassian about Jira which would remove the need for
for Michael, or any of us, to do this work by hand. I got no feedback from anyone, so I rather created a similar feature request:
https://jira.atlassian.com/browse/JSW-14843. I invite everyone to vote for it and add comments if necessary, thanks!
Jacques
