In order to have a clear, readable record of changes made to the ACME source, its essential for all commit messages to have a similar style and content.
All commit message should have a title and a body.
In addition to JIRA issue numbers, you may, but are not required, use other commands to manipulate the associated JIRA issue. See JIRA and Github linking.
Commit message in a feature branch
| Code Block |
|---|
Describe changes in less than 70 characters in title. Be sure to add a blank linebetween title above and this text. In the body of the message provide more detail on what these changes do. It should be enough information for someone not following this development to understand. [non-BFB] or [CC] !! Add ONE of these keys to indicate if this will affect model results to roundoff [non-BFB] !! or climate changing [CC]. If neither is present, commit is assumed to be bit-for-bit. AG-67, AG-56 (Add JIRA issue numbers for issues this commit is satisfying) |
Commit messages in a bug fix branch
| Code Block |
|---|
Describe changes in less than 70 characters in title.
Be sure to add a blank line above. In the body of the message provide more detail on what these changes do.
It should be enough information for someone not following this development to understand.
Fixes #XY, Fixes #MN (include Github issue numbers for the bugs this commit fixes. Be sure to use the word "Fixes"
before each # to close the associated bugs)
[non-BFB] or [CC] !! Add ONE of these keys to indicate if this will affect model results to roundoff [non-BFB]
!! or climate changing [CC]. If neither is present commit is assumed to be bit-for-bit.
OG-54 (if there are also JIRA issue numbers, add those below github issues)
|
Merge commit messages (For IntegratorsMerge commit messages (For Integrators when merging to "next" or "master")
| Code Block |
|---|
Merge branch <branchname> (PR#10) !! Add the PR # to the automatically generated title. (Be sure to add a blank after above title) (copy and paste the original description from the PR) (copy and paste the testing description in the PR and add info on any more testing done prior to merging) Fixes #XY, Fixes #MN (include Github issue numbers for the bugs this commit fixes. Be sure to use the word "Fixes" before each # to close the associated bugs) [non-BFB] or [CC] !! Add ONE of these keys to indicate if this will affect model results to roundoff [non-BFB] !! or climate changing [CC]. If neither is present, commit is assumed to be bit-for-bit. LG-92 (if there are also JIRA issue numbers, add those below github issues and BFB keys.) |