Versions Compared

Key

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

...

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.

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.

Do not include URL's to Confluence or other web sites in the commit message.   For PR's, use the first comment after the description to add URL's or more detail.

...