...
Committers (and other contributors who use Git) should use the following template for their commit messages: (note that with
| Jira |
|---|
| server | ASF JIRA |
|---|
| serverId | 5aa69414-a9e9-3523-82ec-879b028fb15b |
|---|
| key | OFBIZ-11298 |
|---|
|
we
have added a new line between put Jira issue in the title
and the Jira issue number)
| Tip |
|---|
| title | Commit message template |
|---|
|
[Implemented | Improved | Fixed | Completed| 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] |
...
- 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 , separated by a new line, 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 |
|---|
| title | Example 2 (with JIRA and thanks) |
|---|
|
Improved: Clean up commented out code in XML for Common component.
(OFBIZ-8091)
Thanks: Aman for the contribution. |
...
| Info |
|---|
| title | Example 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. |
...