GEODE-nn: 50 chars or less summary

More detailed explanation with linefeeds to wrap at 72 characters after a blank line following the summary.

Further paragraphs come after blank lines.  Bullet points are okay, too.  Typically a hyphen or asterisk is used for the bullet, followed by a single space, with blank lines in between, but conventions vary here.  Use a hanging indent.

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.

For example, 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
  • GEODE-nn: variable name fixes

[1] How to write a Git commit message.


Here's an example of a good commit message:

GEODE-9666: Avoid caching InetSocketAddress (#6938)

The changes for GEODE-9139 changed the behavior of
org.apache.geode.distributed.internal.tcpserver.HostAndPort to
permanently cache the internal InetSocketAddress once it has tried one
time to resolve the address. This undoes part of the fix introduced by
GEODE-7808, in which HostAndPort was created as a way to hold an
unresolved hostname.

The issue is that the cached InetSocketAddress may contain a stale or
unresolved address which will be returned by getSocketInetAddress for
the lifetime of the HostAndPort/InetSocketWrapper object. This prevents
the address from being resolved correctly after changes in DNS records.
(Such changes are common in cloud environments.)

This commit removes the cached internal InetSocketAddress from
InetSocketWrapper so that getSocketInetAddress will try to resolve the
address each time it is called with an unresolved address

  • No labels