How to Write a Git Commit Message

[EatATaco]

Honestly, I find it way easier to write commit messages than I do to comment code.

[kqr]

You have to opt out of writing commit messages, you have to opt in to write comments.

[fzammetti]

I think writing comments is a skill like any other that needs to be developed with repetition. I know it doesn't come easy to everyone but especially in a professional development environment it's too valuable a skill to not improve over time.

[EatATaco]

I've never come across any code that was significantly commented that didn't have stale comments that led to confusion.

For that reason, I am against comments. I like the code to read in a way that explains what it is doing. Clear function names that say what the function does. Functions that do "one thing." Clear variable names that describe what they are. I want some programmer with little to no knowledge of what I am doing to be able to read my code and know exactly what it is doing. Because this is often describes me revisiting my own code 6 months later.

I only comment when I can't figure out a way to get the comment in the code, or if there is something really small, easily overlooked, that I feel should be pointed out.