Ned Batchelder (@nedbat@hachyderm.io)
Föderation EN Di 17.09.2024 12:47:06
A list of commits is not a changelog!
(Medien: 1)
Bruno Rocha (@rochacbruno@social.rochacbruno.com)
Föderation EN Di 17.09.2024 12:50:48
@nedbat My changelog is built on top of convential commits + PRs, working good. https://github.com/dynaconf/dynaconf/releases/tag/3.2.5
Ned Batchelder (@nedbat@hachyderm.io)
Föderation EN Di 17.09.2024 13:33:28
@rochacbruno This is better than a list of commits, but I'd rather hear more about each change, with links to docs, implications for users, etc.
Sumana Harihareswara (@brainwane@social.coop)
Föderation EN Di 17.09.2024 13:56:48
Am I right in inferring that you distinguish between a changelog and release notes? I figure:
Changelog: fundamentally a detailed, comprehensive list
Release notes: a prose summary, easier to read quickly, may include time horizon info such as "this is the penultimate release in the 3.x series" plus "thanks to our sponsors" and "please test this new feature"
I'm fond of the "code tour" style of changelog that Dreamwidth does (example: https://dw-dev.dreamwidth.org/239310.html )
@rochacbruno
Ned Batchelder (@nedbat@hachyderm.io)
Föderation EN Di 17.09.2024 14:02:16
@brainwane @rochacbruno I hadn't made that distinction. I want a changelog to be user-facing, which I guess is more like release notes.
Sumana Harihareswara (@brainwane@social.coop)
Föderation EN Di 17.09.2024 14:14:03
I sense that one of us may write a blog post about this
@rochacbruno
Ned Batchelder (@nedbat@hachyderm.io)
Föderation EN Di 17.09.2024 14:17:35
@brainwane @rochacbruno I'm a bit surprised to find that I haven't already....
Föderation EN Di 17.09.2024 13:04:27
@nedbat but what about a list of PR titles?
Ned Batchelder (@nedbat@hachyderm.io)
Föderation EN Di 17.09.2024 13:32:03
@ogi Better, but still not a changelog. Tell me about the things I need to know. Give me the implications, and links to docs. "Updated dependency xyz to v4.3" is useless.
Föderation EN Di 17.09.2024 13:40:25
@nedbat was mostly joking as the changelog for #PyQtGraph is a list of PRs, but in categories highlights, bug fixes, performance improvements, api changes, etc etc ... I know it's not great , but I've found that to be the fastest way to put something resembling something coherent.
One thing that I do hate about working in open source (while parenting and working a full time job) is that I know what I need to do to make something as good as the users deserve, I just don't have the time to do so.