In order to have a clear, readable record of changes made to the ACME E3SM source, its essential for all commit messages to have a similar style and content. We do not use the "ChangeLog" file that was in CESM. The "git log" command and good commit messages replaces the ChangeLog file.
All commit message should have a title and a AND a body. Just repeat the title for the body if you can't think of anything to add.
The title should completely describe the change within its character limits. Do not continue the sentence in to the body.
In addition to JIRA issue numbers at the bottom of the commit, you may, but are not required to, use other commands to manipulate the associated JIRA issue. See JIRA and Github linking.
Commit message in a branch
| Code Block |
|---|
Describe changes in less than 70 characters in title. Be sure to add a blank between 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. DO NOT LEAVE THE BODY BLANK. Just repeat the title if you have to. [BFB] or [non-BFB] or [CC] !! Add at least ONE of these keys to indicate ifhow this commit will affect testing results to roundoff against baselines. !! [BFB] means all output from tests will be [BFB] with the baselines. !! [non-BFB] one more more tests will not be BFB with baselines. !! You orcan climatespecify changingthe [CC]. [BFB] if commit is bit-for-bit and tests. You can also !! use [non-BFB] and follow it with a description of what cases will be non-bfb if those arent under test. !! [CC] the youcommit knowwill allchange the tests will pass without regenerating baselines.climate of one or more cases under test. [FCC] !! Add [FCC] if the commit will change climate if a flag is activated. [NML] !! Add [NML] if the commit introduces changes to the namelist. AG-67, AG-56 !! (On the last line, add JIRA issue numbers for issues this commit is satisfying) |
...
if available. |
Merge commit messages (For Integrators when merging to "next" OR "master")
...