this post was submitted on 12 Dec 2023
807 points (99.0% liked)
Programmer Humor
19488 readers
597 users here now
Welcome to Programmer Humor!
This is a place where you can post jokes, memes, humor, etc. related to programming!
For sharing awful code theres also Programming Horror.
Rules
- Keep content in english
- No advertisements
- Posts must be related to programming or programmer topics
founded 1 year ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
do
git commit -vand then just summarize the diff you have in your editor in a human readable form.Don't just summarize the content though, summarize the rationale or how things connect. I can read your diff myself to see what changed, I want to know the logical connections, the reason you did X and not Y, etc.
Or just say "stuff" and provide that context in the PR description separately, no need to overdo the commit log on a feature branch if you're using squash merges from your PR.
P1000x this.
I can read a diff.
I need to know why.
No, a code comment isn't good enough, it's out of date after the next commit.
Code comments for "why"s that persist. Commits for why's that are temporary.
If you need to run X before Y, add a comment. If you added X before why because it was easier, leave it in a commit
Add a test that asserts that.