@movq@www.uninformativ.de Hahaha, great timing! :-D I love your article and agree with almost all your points.
On the AI changelog part, though, Iâd rather recommend to just not have a changelog at all.
Another important thing for me is the deprecation notice section. What do I need to look out for in the future? Should I start to migrate to another API soon? Even right now? Or does it have time?
While going through these terrible GitHub release pages, I also found these âNew Project Contributorsâ sections (yeah, for that, they found the time to make a section) annoying. Donât get me wrong, sure, credit where credit is due. But come on. Soooooo much space for an inefficiently formatted (and also unsorted) list. At least it was easy enough to skip over it.
And then, there are also these changelogs or rather notice documents in general that are infested with multicolored emojis all over the place. My brainâs spam filter kicks in and shoves everything to /dev/null immediately. Itâs especially a thing at work.
In my previous work project, we also used the Keep A Changelog Format. That was great. You wouldnât believe how often I resorted back to that document. At least twice a week, often several times a day. I was very glad that we put in this effort. Of course, writing the changelog took its time, but it was worth every minute and more. Reading a many months old item, it was immediately clear. I was our best customer in that regard.
Now, itâs just the same auto shitshow with MR titles in a rolling date-versioned release scheme. Itâs just our team who has to deal with that, though. I think Iâm the only one who is not a fan of it.
