If I want my history, motivation and context to be ephemeral I put it in a commit message.
It still perplexes me why people obsess over commit messages while the places where people are actually looking when they have these questions are neglected.
If I want my history, motivation and context to be ephemeral I put it in a commit message.
It still perplexes me why people obsess over commit messages while the places where people are actually looking when they have these questions are neglected.
If thats what you got from my comment then you misinterpreted it.
Nobody wants docs to look like commit messages. They want them to be relevant to the context.
The commit message is one place - and gives the author an opportunity to speak directly with a future developer over the place-in-time-context that this change was made.
If devs are constantly asking "what the fuck?" all over the code base then that's usually coz tests, code comments, docs and code quality were all badly neglected.
Better commit messages are a band aid over that gaping wound.
As a lame example - Incident Response/SRE will also be trying to get their heads around changes being made - especially if they're responding to an outage, and trying to figure out what change broke production - and why it was made.
Not everyone will know every bit of the project as intimately as the Dev team - and having a good commit message will help any unfamiliar response team mitigate, or escalate accordingly.
If you put some effort into your runbooks, not your commit messages, thats where they'll really appreciate good, detailed writing.