3 ms·
One of my biggest pet peeves is poorly formatted commit messages. I have one coworker who continually fails to put the empty line between the first line and th
by tomswartz07 12y ago
One of my biggest pet peeves is poorly formatted commit messages.
I have one coworker who continually fails to put the empty line between the first line and the body of the commit message. So many of our git logs are littered with 100+ character long messages.
The other commenters hit the nail on the head with the fomatting. Short, precise, and properly formatted.
- babuskov 12y agoWe had an interesting policy in the company where I worked before and I use it for my own projects: only one line is ever allowed - explaining WHAT was changed. - to explain HOW it works: comment in the code, so whoever comes to change the code later knows what should be touched and what should be left alone - to explain WHY it was changed, use the bug tracker and just supply the #ID of bug/feature request in the comment Having single-line comments makes it much easier to browse through history and find the thing you're looking for.
- tomswartz07 12y agoI totally agree- That sounds like a wonderful policy to have. Unfortunately, the powers-that-be aren't too keen on enforcing something like that in our current projects.