Hot take: Even these ‘useless’ comments help, since they relieve you of the burden of reading the code itself, even if it’s trivial. One line of English is easier to parse than one line of trivial code.
Yep.
But reading one outdated line of English is worse than reading 5 lines of code and seeing the true picture.
Or, if you’re my manager, there’s just one comment at the top that says “for pizza”
I don’t feel like “ditch comments” is the right solution to “we {forget, don’t care enough} to update comments”.
Exactly! Maybe i’ve never seen a Pizza Box before. For you your code may be trivial. But for someone else an “open before eating” helps a lot.
Client: it doesn’t work
Dev: did you open from the other side?
Client: now when I eat it, it tastes like box.
Hello! I’m a hobbyist in this space (scripting/coding), does anyone here have a:
- gold standard of what commit messages should look like?
- common practice/etiquette for commit message?
I never had a team or guide or mentor and when I saw this i felt that my commits are like smoke signals describing that there’s a fire. which isnt really helpful.
I tried to contribute to a python module that I use daily, my PR was so over engineered (iirc i added just 3 lines, but with tests, screenshots, CI/CD) i think to compensate for my lack of experience that I got called out (“wow this is pretty extreme just for that feature”).
We’re lucky in that the inventors of our technology are still alive (for the most part). So we can ask them: Linus Torvalds on git commit messages
This is really cool
The gold standard, as so often, is to consult an oracle able to tell you what questions you will be asking when looking at the comment or commit in the future. Then answer those questions and write them down.
In lieu of an oracle, use your experience and best judgement.
Oh and never write whole papers to explain what you’re doing, unless you’re actually writing a whole paper. Instead, drop a cheeky
doi;//URI as the only comment of the whole file to document that you’re an experienced enough programmer to copy from papers instead of stack overflow.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.
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.
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.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.
“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.
Fixes #23132: NPE when downloading customersReading 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.
And I still end up doing it wrong
Sounds helpful. I usually eat the pizza with the cardboard box
Fiber. Yum.
Also the crunch 🤌🏻
Do you prefer your pizzas with or without the peel?
Instructions unclear, got the kernel compilation stuck in pizza
Instructions unclear, got dick stuck in a box
But the box is the best part!
He he he.
