openstack/training-guides
Code Issues Proposed changes
training-guides/doc/upstream-training/source/17-commit-message.rst
Akihiro Motoki 994dec43d6 [upstream] Fix typos 
I found several typos during translations.
This commit fixes them.

Change-Id: I9f155fd5a6c0a1523332eebd559f6deee184b56a
2016-10-05 23:56:37 +09:00

1.9 KiB
Raw Blame History

Commit messages

image

Commit messages

  • quality of the OpenStack git history
  • carrot by alerting people to the benefits
  • anyone doing Gerrit code review can act as the stick
  • review the commit message, not just the code
  • Developers read mostly, write occasionally
  • https://wiki.openstack.org/wiki/GitCommitMessages

Bad: two independent changes

image

Bad: new feature and refactor

image

Good: new API + new feature

image

Contents of a Commit Message (Summary Line)

  • Limited to 50 characters
  • Succinctly describes patch content

Contents of a Commit Message (Body)

  • Lines limited to 72 characters
  • Explanation of issue being solved and why it should be fixed
  • Explain how problem is solved
  • Other possible content
    • Does it improve code structure?
    • Does it fix limitations of the current code?
    • References to other relevant patches?

Do not assume ...

  • The reviewer understands what the original problem was
  • The reviewer has access to external web services/site
  • The code is self-evident/self-documenting

Required external references

  • Change-id
  • Bug (Partial-Bug, Related-Bug, Closes-Bug)
  • Blueprint (Partial-Implements, Implements)

Optional external references

  • DocImpact
  • APIImpact
  • SecurityImpact
  • UpgradeImpact
  • Depends-On

GIT commit message structure

image

Exercise

Review each other’s commit messages on the draft