search

vaheqelyan / svelte-grid

A responsive, draggable and resizable grid layout, for Svelte.
https://svelte-grid.now.sh/
MIT License
948 stars 57 forks source link

Release notes? #50

Open frantic0 opened 3 years ago

frantic0 commented 3 years ago

Hi @vaheqelyan,

it's been a while since I have upgraded svelte-grid since v 1.11.0 and I found breaking changes in several points of my code.

The breaking changes at https://github.com/vaheqelyan/svelte-grid/issues/43 seem to be incomplete. I also had a look at the releases but couldn't find any release notes...

Could you provide a list of changes, please?

Thanks, F

frantic0 commented 3 years ago

e.g.

gridHelp.findSpaceForItem

gridHelp.findSpace

frantic0 commented 3 years ago

e.g.

gridItems now have breakpoints

vaheqelyan commented 3 years ago

of course the changelog is awesome, i will probably not work on it now. i would also like to automate this process i can create release notes in the /release section using github, drafting a new release, but as i know, it doesn't generate CHANGELOG.md file

frantic0 commented 3 years ago

it would be really useful to have even a simple change log with a list of changes, so that users can keep track of them.

I've found this project earlier for automating release notes, but I haven't had tried yet

https://github.com/github-tools/github-release-notes

frantic0 commented 3 years ago

that "uncaught type error" due to the gap parameter in https://github.com/vaheqelyan/svelte-grid/issues/66 took some time to sort out and required to go through all examples, issues, a lot trial and error refactoring, etc. I guess it could be sorted through input validation as well.

this https://github.com/vaheqelyan/svelte-grid/issues/54 seems to be a good start to release notes. Perhaps, keeping it pinned so users who are transitioning to the latest to add to it?

Just suggesting that there might be a better way to manage this process.