7 ms·
An important thing for me in a commit message is the "why" of the commit. Sure it can state "changed foo to use blah". But why did they do that is often very im
by graton 6y ago
An important thing for me in a commit message is the "why" of the commit. Sure it can state "changed foo to use blah". But why did they do that is often very important information. Sometimes it is very obvious from the what, but oftentimes it is not. The article didn't seem to mention this, or if it did I didn't notice it.
I usually think a commit message should have a "what" changed and a "why" it changed portion.
Of course putting this information in code comments may also be a wise thing to do.