3 ms·
Commit descriptions describe the change, which is very often different than the design of the code itself. My approach is to use detailed descriptions in both
by jparise 17y ago
Commit descriptions describe the change, which is very often different than the design of the code itself.
My approach is to use detailed descriptions in both places: commit logs track the evolution of the source tree, and comments/documentation describe the design and implementation of the source tree at a snapshot in time (e.g. now/tip).
- diN0bot 17y agogood point. i guess i'm overvaluing the now/tip docs. i definitely delete old docs since that just confuses everything. when i reach that point where i start wanting to revert the repo or backtrack on changes then commit docs will make much more sense. i still leave a good commit message when i can but....documenting the now/tip in the code is far more useful to me currently.