THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Commit Comment Formatting
We SHOULD (see RFC 2119 for meanings of bolded words) standardise the formatting of the rest of the commit comments too, albeit without automated enforcement. I suggest the following:
| No Format |
|---|
QPID-0000, QPID-0001: Summary of contents of commit |
...
Description of contents and purpose of commit. Any other details of commit go here, such as issue summary and how or why this commit fixes it. Complex issues and rationale belong in JIRA comments, however. Related issues are referenced by id only, as PROJECT-0000. |
...
Contributed by Person One <person.two@example.org> |
...
Contributed by Person Two <person.two@example.org> |
In JIRA commit comments the JIRA id MUST appear as the first characters on the first line and MUST be formatted as QPID- followed by the JIRA number in decimal. This MUST be a valid Qpid JIRA id from the ASF JIRA site. If multiple JIRA ids are referenced, they should be separated by a comma and a space and kept together at the start of the first line. There MUST be a colon and a space immediately following the JIRA id(s).
...
In all comments, contributors other than the committer MUST be identified by a valid e-mail address surrounded by angle-brackets and be preceded by their full name. Multiple contributors MUST be listed on separate lines. Contributor lists MUST be separated from the description or summary by a blank line.
| No Format |
|---|
NO-JIRA: Summary of contents of commit |
...
Full description of contents and purpose of commit. Any other details of commit go here, such as issue summary and how or why this commit fixes it. Complex issues and rationale belong in JIRA comments, however. |
...
External reference |
...
<http://tracker.example.com/ |
...
id>
|
In NO-JIRA comments, the first characters on the first line MUST be NO-JIRA and MUST be immediately followed by a colon and a space and a short summary of the commit. There MAY be an external reference to another bug tracking system which MUST be preceded by a blank line. The reference MUST show the full URL of the issue on the external site, surrounded by angle-brackets. The description MUST contain a complete explanation of the reason for the commit if there is no external reference.
| No Format |
|---|
NO-JIRA: Trivial commit description |
In trivial NO-JIRA comments the description paragraph MAY be omitted.