...
The title should completely describe the change within its character limits. e.g. "Add new evaporation scheme", "Fix convection bug". Do Do not continue the title in to the body.
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 In imperative mood, the subject is understood you are talking about the commit or PR. Do not start your message with "This commit fixes...." or "This PR will...".
Keep the body brief. Just a few sentences. For PRs, use the comments after the description to add more detail if you want
For more deailts in PRs, you can add a line (type "--------" on its own line with blank lines above and below) and then add more detail such as figures or references. Or use the first comment after the description.
Do not substitute github issue numbers for descriptions of what you are fixing or doing or use github issue numbers in the title. "Fixes #999" is not a good commit message or title. Imagine that GitHub goes away someday. The commit messages in our git repo should still make sense. Reference issue numbers at the end (the "Fixes" lines) or parenthetically.
Do not include URL's to Confluence or other web sites in the commit message/PR description to explain what you're doing. DOIs are ok. For PR's, add more detail after a line in the PR description or use the first comment.
Commit message or PR description
...