Comment by Ben Buchanan (200ok) on "Do you have a spec for writing git commit messages?"

The true standard is: get your team to agree on something, then enforce it. Whatever works for your team is the right thing. The problem is rarely the standard, it's when individuals refuse to follow the standard used by the rest of the team.

Current standard at work: prefix your commit with the issue key associated with the change, then add a short description of the change in that commit. We use JIRA so that means:

JIRA-123 Refactored foo() behind the API
JIRA-456 Changed colours to new palette

Couple of considerations:

we have a corresponding rule that all commits must be attached to a JIRA key
we have a corresponding rule that commits should (wherever possible) only relate to a single JIRA
in our systems, JIRA keys are automatically links to the JIRA issue (easy to find details)
for version-zero projects we don't require/enforce the JIRA key, just concise descriptions

Search Hashnode