git commit message guideline

Rules for a great git commit message style

• Separate subject from body with a blank line
• Do not end the subject line with a period
• Capitalize the subject line and each paragraph
• Use the imperative mood in the subject line
• Wrap lines at 72 characters
• Use the body to explain what and why you have done something. In most cases, you can leave out details about how a change has been made.

Information in commit messages

• Describe why a change is being made.
• How does it address the issue?
• What effects does the patch have?
• Do not assume the reviewer understands what the original problem was.
• Do not assume the code is self-evident/self-documenting.
• Read the commit message to see if it hints at improved code structure.
• The first commit line is the most important.
• Describe any limitations of the current code.
• Do not include patch set-specific comments.

Details for each point and good commit message examples can be found on https://wiki.openstack.org/wiki/GitCommitMessages#Information_in_commit_messages