3 ms·
Yup. I follow the kernel commit message guide, since it seems pretty reasonable. It's basically: 1. really short summary in a few words, ideally mentioning the
by beatgammit 7y ago
Yup. I follow the kernel commit message guide, since it seems pretty reasonable. It's basically:
1. really short summary in a few words, ideally mentioning the relevant issue(s) in the bug tracker
2. Blank line
3. Longer message, if necessary, to explain the change
If I'm going to be looking back through commit messages, that's the type of commit message I want to read. I want to know whether this commit is interesting or if I can safely skip it.
It doesn't need to be complicated. Just write a short note as if you wanted to remind yourself where you left off when you come back from vacation.
- em-bee 7y agoanother use for commit messages is to document learning. when we figured out how to avoid a certain type error in typescript, we made sure to describe it in a way that we would find it again, or it would come up in a search.