What's your commit message style?

MariaRomanov@lemmy.sdf.org to Programming@beehaw.org – 46 points –

Was digging through a project at work today where some guy in 2014 made 100+ commits in a single day and the only one that had a comment said "upgrading to v4.0".

56

You are viewing a single comment
View all comments

My commits tend to be pretty verbose. Here's an example log from one of my projects.

I follow the standard imperative style for the commit title, and then I use the body to summarize any important internal changes, reflect on the overall project status (for example, what milestones this commit crosses or what other work it might enable or require), and state what I'm going to work on next. I'm sure some people find it too wordy, but I like having the commit history show lots of details about the overall status.

Edit: I always have a descriptive summary, i.e., never one word commits or similar.

you are a pro and I aspire to be you

I'm not sure I do. I wouldn't want to read all that just to find the item that broke. Might be faster to read the code.

That's why git log --oneline exists ;)

I use alias gl='git log --graph --abbrev-commit --no-decorate --date=format:'\''%Y-%m-%d %H:%M:%S'\'' --format=format:'\''%C(8)%>|(16)%h %C(7)%ad %C(8)%<(16,trunc)%an %C(auto)%d %>|(1)%s'\'' --all' It will change your world.

That is sexy. My only problem is that I tend to run my Git operations in a pretty small tmux pane on the side of my editing pane, so that layout ends up being too wide to fit well. I'll definitely keep that alias around for when I have a full screen though!

Haha yea I have written a number of git and docker aliases over the years that are permanently in my dotfiles. I'm always in screen but perhaps will get into this newfangled tmux.