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

Programming

13373 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
alyaza@beehaw.org
Hexorg@beehaw.org
remington@beehaw.org
40
What's your commit message style? (lemmy.sdf.org)
submitted 1 year ago by MariaRomanov@lemmy.sdf.org to c/programming@beehaw.org
52 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
[–] noeontheend@beehaw.org 8 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.

[–] MariaRomanov@lemmy.sdf.org 2 points 1 year ago (1 children)

you are a pro and I aspire to be you

[–] fmstrat@lemmy.nowsci.com 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.

[–] noeontheend@beehaw.org 1 points 1 year ago

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