3 ms·
> [...] I spend time on getting them to understand good git commit messages instead of 'git add . ; git commit -m "some code"' Decisions could also be document
by someweirdperson 4y ago
> [...] I spend time on getting them to understand good git commit messages instead of 'git add . ; git commit -m "some code"'
Decisions could also be documented explicitly, explaining the pros and cons of possible solutions to future readers. However, in absense of this, commit logs may contain this information, better than nothing.
But with all the commits kept from development the logs will contain a significant amount of non-interesting information, and make the history hard to read a few years later. And reading the log to find something will get slowed down by explanations that should be in docunents or comments in the code.
- masklinn 4y ago> Decisions could also be documented explicitly, explaining the pros and cons of possible solutions to future readers. Such decisions would be documented in the commit log. Optionally linked to an expanded version off-log (e.g. mailing list threads, issues, tickets, ...)