this post was submitted on 27 Jul 2023
49 points (100.0% liked)

Programming

13215 readers
1 users here now

All things programming and coding related. Subcommunity of Technology.

This community's icon was made by Aaron Schneider, under the CC-BY-NC-SA 4.0 license.

founded 1 year ago
MODERATORS
[email protected]
[email protected]
[email protected]
49
What's your commit message style? (lemmy.sdf.org)
submitted 1 year ago by [email protected] to c/[email protected]
57 comments fedilink hide all child comments
 

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".

you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 11 points 1 year ago* (last edited 1 year ago) (2 children)

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.

[–] [email protected] 2 points 1 year ago (1 children)

you are a pro and I aspire to be you

[–] [email protected] 2 points 1 year ago (1 children)

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.

[–] [email protected] 1 points 1 year ago (1 children)

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

[–] [email protected] 1 points 1 year ago (1 children)

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.

[–] [email protected] 2 points 1 year ago (1 children)

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!

[–] [email protected] 1 points 1 year ago

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.