3 ms·
This has been missing for a long time. Part of the programmer culture appears (unfortunately) to include writing code and then thinking that explaining the thi
by grandalf 12y ago
This has been missing for a long time.
Part of the programmer culture appears (unfortunately) to include writing code and then thinking that explaining the thinking behind the code is beneath you.
This is evidenced by the very large percentage of open source releases where the first commit is a very polished codebase.
- sbov 12y agoI agree - whys are very important. I try to document why I do certain things with comments. That said, is there a such thing as a commit message too long? If I were to include the thinking behind code I would have some commit messages over 500 lines long. Currently I just create an Evernote note for each change I make, which documents all the whys, the research, the issues, pros/cons, etc. with a given change. The commit message usually gets a much briefer version of it.
- grandalf 12y agoI think for practical purposes there would ideally be a convention for the high level aspect of a commit message and the details... Though the counter-argument is to commit exactly when a single reasonable commit message contains enough information... squashing defeats this.