search

kukhariev / ngx-uploadx

Angular Resumable Upload Module
https://github.com/kukhariev/ngx-uploadx
MIT License
43 stars 23 forks source link

Please include a Changelog #271

Closed siovene closed 4 years ago

siovene commented 4 years ago

It's very useful for libraries like this one to include a changelog that helps with migration. I was just upgrading from 3.4 to 3.5 and that has breaking changes that are not documented.

Describe the solution you'd like A Changelog file with a description of the updates and the breaking changes.

Describe alternatives you've considered I have to read the code to understand how to migrate my code.

Additional context Thanks!

kukhariev commented 4 years ago

Sorry for my mistake. I published a new version on npm instead of the invalid 3.5.1(#247)

siovene commented 4 years ago

Thanks, I simply cast the response to string to fix the breakage, but the request for a Changelog still stands :) File uploading is the most important feature of my app (image hosting) so I have to be careful when upgrading ngx-uploadx!

siovene commented 4 years ago

Oh and PS: any reason why the release of 3.5.2 is not on master?

kukhariev commented 4 years ago

I use master branch for development. Too many major changes since version 3.5.

I have added a changelog for 3.x, but I am not sure about its format.

siovene commented 4 years ago

Looks good to me, thanks!