3 ms·
> Should commit summaries describe the change, or the intent? Yes. Intent first, then a high level summary of the changes (if non-trivial). Some programmers
by naruhodo 3y ago
> Should commit summaries describe the change, or the intent?
Yes.
Intent first, then a high level summary of the changes (if non-trivial).
Some programmers say that the code is the documentation and that comments in code are a "code smell". I strongly disagree.
The code is a communication between the programmer and the compiler, and leaves out intent. The code does what it does, right or wrong. But what we care about is what we intended the code to do, and why.
So intent is more important because the code could be wrong.