WebReflection / linkedom

A triple-linked lists based DOM implementation.
https://webreflection.medium.com/linkedom-a-jsdom-alternative-53dd8f699311
ISC License
1.62k stars 78 forks source link

[META] Update changelog? #250

Closed asportnoy closed 8 months ago

asportnoy commented 8 months ago

It would be great if you could start a changelog highlighting the differences between versions, especially when it comes to things like potential breaking changes. Currently I just look through the commit logs, but that has the possibility of me missing something important, plus just taking more time.

Many projects just create a release on GitHub alongside their tags with just a few bullet points about what has changed, so I think that would be a pretty good way of approaching it and shouldn't take much extra time.

Thanks!

WebReflection commented 8 months ago

There have never been breaking changes so far but be assured when that'd be the case I'll follow any best practice to mention those. LinkeDOM is a "forever improving" module and by no mean what works already should ever break.

I've been admittedly sloppy in terms of releases but I also have zero time these days to do all the things properly as I'm dealing with dozen+ modules and my time is limited.

Apologies for making you ever thing I'll break stuff in here ... any PR is about improving what's working already, no breaking change happens, and the day that will happen there will be a major release.