Programming

13368 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]

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] 5 points 1 year ago

I try to follow the BLUF pattern: Bottom line up front. The first line is as short a description of the change ("Re-fixed a bug where a URL without a verb could crash the bot.") with some detail following ("I thought I caught that a couple of years back...")

I try to save the detail for the code itself: Comments describe what I was thinking at the time for context, the code is the code. I don't replicate the code comments in the commit message because having the same thing in two places means having to keep two things up to date, and that rarely goes well.