Git

Git commit message

• References

  • http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
  • http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message

    This is very informative, but might be a bit too strict?

• In short,

  • Capitalize
  • Imperative form

• Examples

  • Rails repository

Manners

• 1 PR should do 1 thing.
• 1 PR might include some changes, but all of them should be for 1 thing.
• Commits should be separated to meaning flock for a reviewer to check the PR (each commit) easily.

Typical commit messages

• Make changes according to review

  It's ok sometimes when you make small changes in one commit. But try to write a specific message. (This example is not specific although I think it's acceptable.)

• Replace <old> with <new>
• Rename <old> to <new>
• Add ~
• Remove ~
• Fix ~
• Refactor ~