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.
How would you automate changelog generation and semantic versioning without conventional commits? For me, this is the biggest selling point of this standard, when paired with tools like Release Please.
## Release notes
- Fixed foo returning baz instead of bar when qux is passed in
Your commit messages are pretty useless to the people actually reading the changelogs. If you need automatic changelog generation, then stitch it from parts written for humans to read.
You don’t. Users are different audience than the development team. Messages intended for one group are different from those for the other. This is my biggest gripe about this “semantic” BS. Commit comments are for the dev team. You should summarize it in a way that makes sense to users.
Every time I see a “changelog” from a team for something I use that is full of “fix: loop pointer in Foo.java” I just roll my eyes. Like that tells me anything useful. If I cam technically savvy enough and care I can go look at the git history. But as a user that’s meaningless.
How would you automate changelog generation and semantic versioning without conventional commits? For me, this is the biggest selling point of this standard, when paired with tools like Release Please.
In your PR:
Your commit messages are pretty useless to the people actually reading the changelogs. If you need automatic changelog generation, then stitch it from parts written for humans to read.
You don’t. Users are different audience than the development team. Messages intended for one group are different from those for the other. This is my biggest gripe about this “semantic” BS. Commit comments are for the dev team. You should summarize it in a way that makes sense to users.
Every time I see a “changelog” from a team for something I use that is full of “fix: loop pointer in Foo.java” I just roll my eyes. Like that tells me anything useful. If I cam technically savvy enough and care I can go look at the git history. But as a user that’s meaningless.