2 ms·
I went through a period of writing essay-length commit messages, on the basis that they were a form of documentation that I could completely trust because they
by simonw 5y ago
I went through a period of writing essay-length commit messages, on the basis that they were a form of documentation that I could completely trust because they were entirely accurate to the state of the software at the time of the commit.
Then I realized that if I bundle the documentation change itself into the same commit I can have the same benefit while also creating documentation that people can read without digging through the commit log to find it!
These days my commit messages are much shorter, but the commits usually bundle implementation, tests and documentation updates into the same unit.
I also make sure my commits link out to a relevant issue. This gives me somewhere I can record additional context and drop in things like screenshots that help illustrate my thought process while working on the code.