...
The title should completely describe the change within its character limits. e.g. "Add new evaporation scheme", "Fix convection bug". Do not continue the sentence in to the body.The first sentence of the body should be passive and not contain a subject
Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug." This convention matches up with commit messages generated
by commands like git merge and git revert. It is understood you are talking about the commit or PR. Do not start with "This commit...." or "This PR...".
...
Keep the body brief. Just a few sentences. For PRs, use the comments after the description to add more detail if you want.
...
| Code Block |
|---|
Merge branch <branchname> (PR #10) !! Add the PR # to the automatically generated title. Leave "into next" in title when merging to next.
!! Add "into maint-1.0" for maintenance branch commits. Don't worry about going over the 70 char limit.
(Be sure to add a blank after above title)
(copy and paste the original description from the PR. It may already have the content below.)
(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)
[BFB] or [non-BFB] or [CC] !! Add ONE of these keys to indicate if this commit will affect testing results to roundoff [non-BFB]
!! or climate changing [CC]. Use [BFB] if-and-only-f commit is bit-for-bit and
!! you know all the tests will pass without regenerating baselines.
[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.
LG-92 (if there are also JIRA issue numbers, add those below github issues and BFB keys.)
(If the merge produces merge conflicts, the list of files that were in conflict should be left in the message.)
|
...