Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

In order to have a clear, readable record of changes made to the ACME source, its essential for all commit messages to have similar style and content.

 

Commit message in a feature branch

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.
 
[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

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 Integrators)

Merge branch <branchname> (PR#10)      !! Add the PR # to the automatically generated title.


(copy and paste the original description from the PR)

(copy and paste the testing description 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.)
 
 
  • No labels