There’s a community standard out there called Conventional Commit for structured git-commit messages. If you don’t know about it already, it recommends a strict type(scope?): description format for describing a code change in a repo.
The customer receives a list of feat and fix commit titles as info with a release.
The problem is that the language customers want and the language developers want are different things. Abusing commit messages to try to create documentation is just a bad idea. Spend a few mins to summarize for your users what has changed. You should be able to pull the tickets that went into a release for that pretty easily. Hell have AI do it if you’re that lazy. But as a developer I want to know what your commit did. Just explain your change in a way that will help me later on.
I find a commit message describing consequential effect and intended goal/change more useful than technical details. And those are usually what the customer cares about. “function/action works again” “fix x by y” “introduce functionality x”.
But as a developer I want to know what your commit did.
I agree. I don’t see them as opposites or contradicting to pulling them. Either as a free information forward, or as a basis for describing it into something a customer understands, or into what is notable about a release.
The problem is that the language customers want and the language developers want are different things. Abusing commit messages to try to create documentation is just a bad idea. Spend a few mins to summarize for your users what has changed. You should be able to pull the tickets that went into a release for that pretty easily. Hell have AI do it if you’re that lazy. But as a developer I want to know what your commit did. Just explain your change in a way that will help me later on.
I find a commit message describing consequential effect and intended goal/change more useful than technical details. And those are usually what the customer cares about. “function/action works again” “fix x by y” “introduce functionality x”.
I agree. I don’t see them as opposites or contradicting to pulling them. Either as a free information forward, or as a basis for describing it into something a customer understands, or into what is notable about a release.