jgarden/a small git commit reference
GitHub ↗Let’s connect
wiki / JGARDEN

A small Git commit reference

A practical reference for a small git commit reference, with examples and the important failure boundaries.

Commit shape

<type>(<scope>): <short description>

Use an imperative description that explains the change. Keep the scope meaningful to the repository.

Common types

TypePurpose
featAdd a capability
fixCorrect behaviour
docsChange documentation
refactorRestructure without changing behaviour
testAdd or correct tests

Example

fix(consumer): commit offset after durable handling

Preserve retry eligibility when persistence fails.

Commit conventions make history easier to scan. They do not replace a useful explanation in the pull request.

Sources

Continue exploring