3 ms·
I'm not suggesting that the version you gave would be a problem in practice; I'm also not suggesting that the commit message in the article is the best possible
by JoshTriplett 7y ago
I'm not suggesting that the version you gave would be a problem in practice; I'm also not suggesting that the commit message in the article is the best possible commit message for that change. I'm suggesting that after a long debugging adventure, I'd prefer to err on the side of including any information that feels hard-won, rather than trying to make the message as concise as possible at the possible expense of missing an important detail.
I've read many commit messages with too little detail, and zero with too much detail. (I have read code with too many comments, but it's rare; I've never once read a commit message that made me think "too much detail".) I'm sure it's possible, but on balance I prefer to cultivate instincts of "document anything that was hard to learn" and "in the moment, prefer to over-document rather than under-document".
- BoorishBears 7y agoIsn’t this exactly what I said in my original comment... I appreciate the intention and wouldn’t complain, it’s just if you care enough to write so much, save yourself sometime and the next person to read it some effort by being a little more concise. Commit messages are like naming things, there’s no right way, but the more you try to do it “right” the more “right” you get. If you just throw your hands up and say “I’m goin to vomit our every thought I had working on this”, sure it won’t kill anyone and it’s preferable to always writing nothing (that’s kind of obvious...), but you’ll never get to the point where writing even somewhat balanced messages is comfortable