Semantic Commit Messages

03-20-14 Jeremy Mack

See how a minor change to your commit message style can make you a better programmer.

I use a rigid commit message format, and it makes me a better programmer.

Resource

    feat: add hat wobble
    ^--^ ^------------^
    | |
    | +-> Summary in present tense.
    |
    +-------> Type: chore, docs, feat, fix, refactor, style, or test.
    view raw commit_format.txt hosted with ❤ by GitHub

    More Examples

    chore: add Oyster build script
    docs: explain hat wobble
    feat: add beta sequence
    fix: remove broken confirmation message
    refactor: share logic between 4d3d3d3 and flarhgunnstow
    style: convert tabs to spaces
    test: ensure Tayne retains clothing

    That's It

    You'll never again be tempted to include a bug fix and a feature in the same commit. My git log is now an easy-to-skim changelog.

    Inspired by Karma's commit style.