HNhnarn·Sep 1, 2020
This looks really impressive, and I don't want to take anything away from the quality of the code itself here, but I feel like I have to point out that this repo is a school book example of how commit messages should not look:
- "update" https://github.com/cleardusk/3DDFA_V2/commit/a339c36d795b4d6...
- "some updates" https://github.com/cleardusk/3DDFA_V2/commit/a8cab53dbaa87d1... (license change mixed with code)
This is an easy pattern to fall into when you're the only one in the project, I've been there myself, because you feel like "it doesn't matter, this isn't quite done yet anyway, and noone else will read it".
Well, here's the point:
- "Someone else" may very well be yourself a few months from now. Don't avoid good git practice, you're shooting yourself in the foot.
- Even if noone will read it now, someone may read it way down the
Read the rest
line, when that one line you changed caused a really annoying bug. Imagine the feeling when the commit has no information on why the change was made. Commit messages are mandatory for a reason.
- If commit messages are not atomic and mix different files that aren't logically related, understanding what was done will be extremely hard, even for yourself looking back.
There are many guides available online on how to write good commit messages, I won't point out a single one of them as I don't feel one is authoritative over all others.
I'd also like to point out that this is something you need to know if you're ever going to collaborate on software projects, so learning it now is as good as a time as any.