Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updates after convo on dev ML

...

The history is also the main source for our development report as part of the monthly Apache OFBiz blog. To put it together more efficienlty, we'll try to automate the process and a unified format will support this process very well.

Committers (and other contributors who use Git) should use the following template for their commit messages: (note that with

Jira
serverASF JIRA
serverId5aa69414-a9e9-3523-82ec-879b028fb15b
keyOFBIZ-11298
we put Jira issue in the title)

Tip
titleCommit message template
[Implemented | Improved |Fix Fixed for| Completed|Documentation|Reverts Documented | Reverted]: [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]

...


Some rules apply to the template:

  • line 1:
    • is mandatory, the following lines are optional.
    • a ":" follows after the kind of implementation/source of work.
    • the Jira title or any other text must not be quoted ("").
  • the Jira reference is written in parenthesis, no whitespace. It's possible to group several JIRA references together, if applicable. JIRA references are optional (in case there is no Jira).
  • no separators between the lines, just new lines.
  • remarks regarding the patch (e.g. modifications) and the issue itself are described in the details.
  • the optional details are separated by blank lines before and after.
  • the line length should not exceed 80 characters.

 


Info
titleExample 1 (no Jira)
Improved: Migrated unit tests for UtilCodec defined in the old 
"integration test" group to the new class that contains actual
unit tests for the UtilCodec class.

...

Info
titleExample 2 (with JIRA and thanks)
Improved: Clean up commented out code in XML for Common component.
(OFBIZ-8091)

Thanks: Aman for the contribution.

...

Info
titleExample 3 with details and multiple Jira references
Improved: Consistent menu names
 (OFBIZ-8118)(OFBIZ-8122)(OFBIZ-8123)
(OFBIZ-8124)(OFBIZ-8125)(OFBIZ-8126)
(OFBIZ-8127)(OFBIZ-8128)(OFBIZ-8129) Menu names should be in camel case to maintain consistency. I've slightly
modified the provided patch to eliminate names with "-" or all lower case also. Thanks: Tanmay Muley for reporting and providing the patches.

 

IDE support for commit message templates

Eclipse

  1. In Eclipse, go to Preferences / Team / SVN / Comments and put the template in an new entry. You can, for example, create templates for every kind of solution (Implemented, Fixed etc.) separately.
  2. When committing, select the template from the dropdown below the commit message entry field.

...