4 ms·
I completely agree, but as someone who's owned publishing for changelogs on large-ish, often super technical OSS projects, it can be very difficult to explain s
by jyrkesh 4y ago
I completely agree, but as someone who's owned publishing for changelogs on large-ish, often super technical OSS projects, it can be very difficult to explain some of the concepts needed to grok a bugfix or low-level design change even in the span of a couple paragraphs. And more importantly, that context needs to be written by the engineer involved in the change, which means more context == less code work.
That being said, I think some projects do it extremely well. My gold standard for a while has actually been the OSS Dolphin emulator for Gamecube/Wii. They write incredible progress reports[1] every 1-2 months that give phenomenal context on how they found the bug, why it matters, how it works, and what they did to fix it.
Another great example is VS Code[2]. Their context tends to be around changes that are more UX-oriented, but it's still a great way to understand what new value you're getting on every new release.
[1]: https://dolphin-emu.org/blog/2022/02/08/dolphin-progress-report-nov-and-dec-2021-jan-2022/ https://dolphin-emu.org/blog/2022/02/08/dolphin-progress-rep...
[2]: https://code.visualstudio.com/updates/v1_67 https://code.visualstudio.com/updates/v1_67
- tentacleuno 4y agoCheck out the TypeScript release notes if you like extensively documented notes :-)
- frosted-flakes 4y agoThe VS Code release notes are great. I always read through them, and reading about a new experimental feature I can enable if I want to try it out always gets me a bit excited. Why can't Windows put those release notes up-front-and-centre when it continually nags me to update?
- simonw 4y agoOh wow, yeah the VS Code release notes really are superb.