I just keep my commit messages one-liners and elaborate more on pull requests, where there’s enough context to really justify the change.
Putting the message in git puts the information closer to the code, since the pr isn’t in git itself but instead the git forge. You can for example search the text of git messages from the git cli, or come across the explanation when doing
git blame
. I sometimes write verbose commit messages and then use them as the basis for the text in the pr, that way the reviewer can see it easily, but it’s also available to anyone who might come across it when doing git archeology
At work we always put an issue number (together with a short summary text) in the commit message. The the verbose explenation is done in the issue, where formatting, search and filtering is easier. However this creates a dependency to that issue system.
yeah, trying to convince our product owner to read commit messages wouldn’t go smoothly in my team. Some of them love their tickets…
the dependency to the issue system is unfortunate though, I do miss a “decentralized issue system” doing what git does for version control that would just seamlessly integrate with git and have a nice web GUI for less technical folks.
That’s called a mailing list
/s
god, I already struggle trying to find information in github issues, I can’t imagine using email for this
You don’t have to imagine it; you can browse the Linux Kernel mailing list!