3 ms·
Most commit messages look like this: #1234 fixed the fucking fooinater that wouldn't frobulate. Thank god for the hash ticket number linking standard. Unl
by thrower123 7y ago
Most commit messages look like this:
#1234 fixed the fucking fooinater that wouldn't frobulate.
Thank god for the hash ticket number linking standard. Unless you are working on the kernel, your context and discussions and notes are in the bugtracker, so there's no very good reason to write an essay in the commit log.
- reificator 7y agoUntil you switch bug trackers and the import process subtly mangles that link, and then you switch trackers a few years later and all hope is lost, and then five years after that you hire someone to fix all the bugs that you've been accumulating and they can't tell any of the reasoning behind anything you've done. Are you always going to be on Jira? On Github? When people fork your project are they expected to clone your issues as well? When you migrate to another system are all your issue references still going to line up correctly? Did you even think to check? Please continue to include the ticket reference. But also put some context in your commit message because that's what it's there for. This is the same reason that even if you use a fancy documentation site, it should be generated from files in the repo.
- bagacrap 7y agoBroadly speaking, so much documentation is on the issue tracker, that yes, I expect efforts to be made to preserve that content in perpetuity in one way or another.