Yes, that might make it clearer.I will give some examples of existing log messages and how they would look with the new format.
Example 1 (old): ===Applied patch from jira issue - OFBIZ-8091 - Clean up commented out code in XML for Common component. Thanks Aman for the contribution.
=== Example 1 (new): ===Applied patch for: Clean up commented out code in XML for Common component ( OFBIZ-8091).
Thanks: Aman for the contribution. === Example 2 (old): === (OFBIZ-7969) Applied slightly modified patch from jira issue. ================================= Enable adding a content to an agreement ================================= Thanks Leila Mekika for your contribution. === Example 2 (new): ===Applied modified patch for: Enable adding a content to an agreement ( OFBIZ-7969).
Thanks: Leila Mekika for your contribution. === Example 3 (old): (no Jira) ===Improved error message logged by DelegatorFactoryImpl.getInstance(...) when a delegator can't be created; added a TODO comment to remind that the code should be refactored to throw the exception instead.
=== Example 3 (new): ===Improved: error message logged by DelegatorFactoryImpl.getInstance(...) when a delegator can't be created. Details: added a TODO comment to remind that the code should be refactored to throw the exception instead.
=== Example 4 (old): ===A slightly modified Taher's patch for "Load the OWASP dependency checker Gradle plugin efficiently" I reported at OFBIZ-7930
Using OWASP-DC with Gradle was impossible w/o the corresponding plugin. Unfortunately using the suggested way at https://plugins.gradle.org/plugin/org.owasp.dependencycheck loads a lot of dependencies which are only needed by OWASP-DC. So Taher wrote a specific solution to avoid downloading useless libs to a normal use of OFBiz, there it is.
jleroux: I have simply formatted the "if(" to "if ("
===
Example 4 (new):
===
Applied modified patch: Load the OWASP dependency checker Gradle plugin
efficiently (OFBIZ-7930).
Details: Using OWASP-DC with Gradle was impossible w/o the corresponding
plugin. Unfortunately using the suggested way at
https://plugins.gradle.org/plugin/org.owasp.dependencycheck loads a lot
of dependencies which are only needed by OWASP-DC. So Taher wrote a
specific solution to avoid downloading useless libs to a normal use of
OFBiz, there it is.
jleroux: I have simply formatted the "if(" to "if ("
===
Example 2 made me enhance the template:
===
[Applied patch for|Applied modified 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]
===
Hope that's clearer now?
Regards,
Michael
Am 06.09.16 um 11:26 schrieb Taher Alkhateeb:
Can you include some samples Michael, just for clarity? On Tue, Sep 6, 2016 at 12:25 PM, Taher Alkhateeb <[email protected]wrote: +1 I also suggest to have maximum width of 80 characters. This makes things nicer and cleaner for svn log On Tue, Sep 6, 2016 at 11:31 AM, gil portenseigne < [email protected]> wrote:Hi Michael, I like the idea to have unified commit message format. +1 Thanks for the proposal ! Gil On 06/09/2016 10:08, Michael Brohl 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
smime.p7s
Description: S/MIME Cryptographic Signature
