Commits

Messages

What makes a good commit message?

  • Simple and informative description
  • Written in present tense
  • References the task ID
<!-- Good -->
Update nav

<!-- Bad -->
Updates nav
Updated nav
Updating nav

Syntax

For GitHub:

#{taskId} ({taskDescription}): {commitDescription}

For Bitbucket / Jira:

{projectId}-{taskId} ({taskDescription}): {commitDescription}

Example

Pretend we’re making a website for Tony Hawk about skateboarding. There’s a Jira project with the ID HAWK, which includes task 900 for updating the history of skateboarding.

<!-- Good -->
HAWK-900 (skateboarding history): add X-Games to timeline

<!-- Bad -->
Update text