Skip to content
Lab651 Process

Commit Messages

Commit Messages

Section titled “Commit Messages”

When creating a commit message, it is important that the information be meaningful to someone who is going to review your code or review the commit at a later date.  Additionally, when taken as a set, good commit messages can be the basis of release notes (which makes the release notes easier and faster to pull-together).

Bad Commit Messages

  • Did the stuff in the ticket
  • Fixed the bug

Good Commit Messages

  • [ABC-123] Added the regex login username filtering to the login process
  • [ABC-456] Fixed the regex username filter in the login process to allow dashes and underscores
Section titled “Related”