Versions Compared

Key

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

...

Be verbose.  Your commit message should tell the story of your work.  People read our commit logs and understanding what changed (and why) is very helpful.  

Wording of the Commit Message

The commit message should follow imperative style [1]. The wording should fit this phrasing "If I apply this commit, then it will..." for any of the git commits.

Use this wording:

GEODE-nn: Fix failing CompositePropertySourceTest

Instead of:

  • GEODE-nn: Fixing failing CompositePropertySourceTest
  • GEODE-nn: Fixed failing CompositePropertySourceTest
  • GEODE-nn: failing CompositePropertySourceTest
  • GEODE-nn: polishing stuff
  • GEODE-nn: CompositePropertySourceTest is failing intermittently

[1] How to write a Git commit message.