Programmer Humor

32710 readers

284 users here now

Post funny things about programming here! (Or just rant about your favourite programming language.)

Rules:

Posts must be relevant to programming, programmers, or computer science.
No NSFW content.
Jokes must be in good taste. No hate speech, bigotry, etc.

founded 5 years ago

MODERATORS

[email protected]

649

advise (discuss.tchncs.de)

submitted 1 year ago by [email protected] to c/[email protected]

33 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

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

My personal cent: Some tools strongly suggest that your commit messages should not exceed 50 characters in the first line, and 80 characters on every other line. While the 80-character rule makes sense if you’re using a terminal (and someone on your team will even if you don’t), I strongly disagree with the 50-character rule. If you want to be in any way clear what you did, 50 characters is simply not enough even for the subject line.

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

The reason for the approximately 50 character limit is because there's many tools that display a single line and will truncate it if it's more than about that length (though really the point of truncation can vary wildly -- plenty of tools will let you go twice that before they cut you off). So if your one line summary is too long, it'll be cut off and harder to understand your commit at a glance.

You always can elaborate in a second paragraph, at any rate.

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

How much can you really put in 50 characters?

Fix: NPE in customer download component when users – That’s 50 characters. Should I not mention where I fixed the bug?

Fix: NPE when users downloaded customers without s – I think I can get rid of the actor in some cases.

̀ Fix: NPE when downloading customers without select`. The summary I want to give cannot be truncated any further.

Fix: NPE when downloading customers. This fits, but is so vague as to be pointless as a summary, in my view.

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

I don’t follow the 50 character rule, but to answer your first question: imo, no, don’t mention where you fixed the bug. This is a commit message that is explicitly tied to the place where you fixed the bug. You can go into more detail in the PR if you need to.

[–] [email protected] 2 points 1 year ago* (last edited 1 year ago)

“PR” lol. I’m the sole developer.

Jokes aside. I find it easier to have all the information in a commit message, so I can browse it in the git log without having to find the relevant PR(s) that finally merged it.

[–] [email protected] 3 points 1 year ago* (last edited 1 year ago)

Fixes #23132: NPE when downloading customers

Reading that you see:

It's a bugfix, not feature addition or such
The actual ticket number in case you need to dig deeper.
A quick blurb about what and where. The rest is in the code. If the issue title is good you often can simply re-use it (but not always).

It's plenty to orient yourself in case you need to dig in, plenty so that you can skip over the commit if you're looking for something else, and short enough to ignore. If you absolutely need to document more, do it under the fold but that headline there is what should show up in a list of commits.