Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagetext
one-line explanation of commit less(or PR) in LESS than 70 characters

After a blank line, write a more detailed explanation of the commit.
Many tools do not auto-wrap this part, so wrap paragraph text at a
reasonable length. Commit messages are meant for other people to read,
possibly months or years later, so describe the rationale for the change
in a manner that will make sense later.  You might be the one puzzling over
the commit months later so write it for your future self.  
DO NOT LEAVE THE BODY BLANK.  Just repeat the title if you have to.

If you are fixing a bug, it is NOT enough to just do "Fixes #1234" for the body.  Explain the bug and its fix.

The message should prominently state its impact on users, such as a
different interface or a change of bit-for-bit results.

* Commit messages may contain lists.

* Commit messages should NOT contain URLs to Confluence or any other web site within the main body.
Our Confluence is mostly private so it will not help to explain the public commit message.
Commit messages are forever but URLs can break or go stale.  Put URL's with more info at the bottom.  DOIs are ok.

* Following these guidelines improves the ability of tools to quickly
  summarize changes according to various criteria.

If other people contributed significantly to a commit, perhaps by
reporting bugs or by writing an initial version of the patch,
acknowledge them using tags at the end of the commit message.

Reported-by: Helpful User <helpful@example.com>
Based-on-patch-by: Original Idea <original@example.com>
Thanks-to: Incremental Improver <improver@example.com>
Describe changes in less than 70 characters in title.
 
Regular commits: If this affects any known issues, include "see #ISSUENUM" in the message (without quotes).
GitHub will create a link to the issue as well as a link from the issue to this commit,
notifying anyone that was watching the issue.
PR Domessage: not putAdd "Fixes #issuenum" becauseif that is reserved
for the merge commit to master (which actually fixes the bug)this PR fixes a bug.

Add the following tags as appropriate:
 
[BFB] or [non-BFB] or [CC]    !! Add at least ONE of these keys to indicate how this commit will affect testing against baselines.
                              !! [BFB] means all output from tests will be bit-for-bit (BFB) identical with the baselines.
                              !! [non-BFB] one more more tests will not be BFB with baselines.  You can specify the tests.  You can also
                              !! use [non-BFB] and follow it with a description of what cases will be non-bfb.
                              !! [CC] the commit will change the climate of one or more cases under test.

[FCC]                         !!  Also add [FCC] if the commit will change climate if a flag is activated.
[NML]                         !!  Also add [NML] if the commit introduces changes to the namelist.
 
AG-67, AG-56     !! On the last line, optionally add JIRA issue numbers for issues this commit is satisfying if available
Optional for PR:  add a line (------ in markdown) and add below it any other info you want about the PR.  Figures, links, etc.


See also https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

...