Commits

Messages

What makes a good commit message?

  • Simple but informative description
  • Associated to the task

Syntax for GitHub

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

Syntax for 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 commit message

HAWK-900 (skateboarding history): add X-Games to timeline

Bad commit message

Update text