Re:Linus Torvalds: 'I Do No Coding Any More'
by u801e on Sunday July 05, 2020 @04:03PM
(#23741464)
> Never once did I have any indication that someone took their time to read descriptions or commit messages.
Just because others don't use a tool for documenting code doesn't mean the tool shouldn't be used. I make sure the team I work with documents the what was done and why in their commit messsages. I also make sure that, when applicable, they describe the bug that was fixed and how it was fixed in the commit, or how performance was tested by applying a certain fix in the commit message.
Several times over the years, people have gone back to those commit messages by finding them via git blame and figuring out what was done months or years ago and preventing regressions by reading the commit messages.
> Never once did I have any indication that someone took their time to read descriptions or commit messages.
I do admit that I have been tempted to do things like:
Just because others don't use a tool for documenting code doesn't mean the tool shouldn't be used. I make sure the team I work with documents the what was done and why in their commit messsages. I also make sure that, when applicable, they describe the bug that was fixed and how it was fixed in the commit, or how performance was tested by applying a certain fix in the commit message.
Several times over the years, people have gone back to those commit messages by finding them via git blame and figuring out what was done months or years ago and preventing regressions by reading the commit messages.
> Never once did I have any indication that someone took their time to read descriptions or commit messages.
I do admit that I have been tempted to do things like:
git commit --allow-empty-message
for changes and see if anyone would notice.