DEV Community

How much effort do you put into commit messages?

Madza on December 30, 2020

Are you the 'lazy' type and often write them poorly and unorganized, with no proper explanation of the action and later have trouble navigating in ...

Read full post

Peter Benjamin (they/them) • Dec 31 '20 • Edited

I follow the Conventional Commit standard, because it allows me to automate Semantic Versioning in CI pipelines.

Examples:

Added a new CLI command? $ git commit -m "feat: add foo command" && git push then CI tests, builds, and increments MINOR version 1.0.9 -> 1.1.0, and publishes artifacts.
Fixed a race condition bug? $ git commit -m "fix: fix race condition" && git push then CI tests, builds, and increments PATCH version 1.1.0 -> 1.1.1, and publishes artifacts.
If a feature or bug fix is non-backward compatible, then add BREAKING CHANGE in git commit message, which will lead to incrementing the MAJOR version 1.1.1 -> 2.0.

If any change needs some context (eg why the change was made), I add it in the commit message body. More often, I reference the ticket or issue in bug tracker, like:

$ git commit -F- <<EOF
fix: fix race condition

Closes #123
EOF

Jack Williams • Jan 1 '21

I like this, I'm curious, do you use something automated to handle your semantic versioning like this?

Peter Benjamin (they/them) • Jan 1 '21

I use semantic-release for all my projects. I like it because it is language-agnostic.

Add a .releaserc.json config file, which supports a large number of plugins.
Run semantic-release CLI in CI.

Adarsh Sriuma • Jan 4 '21

This looks interesting. I should look this up soon. Maybe I can reach out to you, if I need some help.

Sagar • Jan 6 '21 • Edited

I'm using git alias for writing beautiful commit messages. Below, I pasted a few lines from the .gitconfig file.

# Git Commit, Add all and Push — in one step.
cap = "!f() { git commit -m \"$@\"; }; f"
# NEW.
new = "!f() { git cap \"📦 NEW($1): $2\"; }; f"
# IMPROVE.
imp = "!f() { git cap \"👌 IMPROVE($1): $2\"; }; f"
# UPDATE.
up = "!f() { git cap \"✍🏻 UPDATE($1): $2\"; }; f"
# FIX.
fix = "!f() { git cap \"🐞 FIX($1): $2\"; }; f"
# RELEASE.
rlz = "!f() { git cap \"🚀 RELEASE($1): $2\"; }; f"
# DOC.
doc = "!f() { git cap \"📖 DOC($1): $2\"; }; f"
# TEST.
tst = "!f() { git cap \"🤖 TEST($1): $2\"; }; f"
# BREAKING CHANGE.
brk = "!f() { git cap \"‼️ BREAKING CHANGES($1): $2\"; }; f"
# REMOVE
remove = "!f() { git cap \"🗑 REMOVE($1): $2\"; }; f"
# REFACTOR
ref = "!f() { git cap \"♻️ REFACTOR($1): $2\"; }; f"
# INITIAL COMMIT
int = "!f() { git cap \"🎉 INITIAL COMMIT($1): $2\"; }; f"

Here is an example of an improvement commit.

git imp "scope" "actual commit message"

Madza • Jan 6 '21

This is awesome 👍
Thanks for sharing 🙏❤

Matej Kovac • Jan 5 '21

When working in a team, I always use ticket number and description of a change, where change is always localized, not pushing 50 file changes in a single commit.
This allows me to go back to the ticket when looking at the code to see what were the exact requirements

Don't you just love seeing "WIP" and then 10+ file changed?

On a personal project, I always use some meaningful message, it just helps when looking at git blame and timeframes

Tea • Dec 31 '20

There are conventions; without going semantic versioning all the way:

50 chars max is considered good practice (yes that is extremely terse and I treat it as an ideal vs hard constraint)
A good commit fixes/adds one thing (and a good message concisely spells this out) imho bothering to detail commits beyond the terse one liner often signals an issue with the commit itself (not always)

In a team environment:

Except under duress/time pressure will not skimp on the extra time needed to write a concise, informative commit message.
Will definitely review commits more carefully if a concise, informative message is not provided (and likely to ask for an updated diff)

Own work: will stop and ask myself what's going on when I err on the "improved a thing" side of things for any length of time as this could signal I'm losing focus or trying to muddle through/conflating separate issues.

German Chyzhov • Jan 10 '21 • Edited

We are using strict git conventions at our project.
It includes branch naming like [feature|bugfix]/XXX-YYY-3-words-description, where XXX is a short name of project in Jira and YYY is a number of ticket.

For git commits we are using rules:
1) Name like XXX-YYY Do something
2) Name should be up to 80 symbols, detailed description if needed comes as new lines
3) Name should have imperative voice like "Do...", "Make...", "Fix..." instead of "Did","Making", "Fixes"

PR's should have the same naming conventions as git commits.

Madza • Jan 11 '21

Talking about being organized 💯👍

Juan Jaques du Preez • Jan 1 '21 • Edited

Did you know a commit can be quite long actually? I usually have a short title like 'Ticket Number: short description' and then follow with details in a short paragraph.

It may be overkill but commits aren't for you. It's for the poor maintainer trying to add a new feature a year from now. It helps for them to know what the hell you were thinking when you made the change.

gawonmi • Jan 8 '21

this

Yoginth • Dec 31 '20 • Edited

Here are my examples!

$ git commit -am "Update icons in dark mode and Closes #256"
$ git commit -am "Add a new class to support mobile devices and Closes #259"

michelledev • Jan 4 '21

I think I will remember and bam, 10 commits later--no idea. I have been getting better with specifics, but sometimes I fall back into bad habits. Nice article Madza!

Pacharapol Withayasakpunt • Dec 31 '20

git commit -m update

Seriously lazy sometimes.

Adarsh Sriuma • Jan 4 '21

Thank you for sharing this. It's looks fun and interesting to include Gitmoji's as a single shot summary. I should start following this in my future commits.