avoidwork / filesize.js

JavaScript library to generate a human readable String describing the file size
https://filesizejs.com
BSD 3-Clause "New" or "Revised" License
1.61k stars 97 forks source link

Add changelog #97

Closed Ky6uk closed 5 years ago

Ky6uk commented 5 years ago

I have noticed library has been updated from v4.0.0 to v4.1.1 but I can't find changelog for that. It could be nice to write some strings about changes (different file or maybe inside github releases page).

Right now it's a little bit hard to maintain TS definitions for this library when you don't know about changes.

avoidwork commented 5 years ago

https://help.github.com/articles/comparing-commits-across-time/

https://github.com/avoidwork/filesize.js/compare/4.0.0...4.1.1

I forgot to tag & push 4.1.0, so I'll do that now

Hypnosphi commented 5 years ago

Comparing tags is good, but I'd like to know which of the commits are breaking changes

avoidwork commented 5 years ago

https://github.com/avoidwork/filesize.js/compare/4.2.0...5.0.0

there's not a single commit with a breaking change consistently, because i don't care to squash commits as there's value in being able to cherry pick aspects of a change (if possible / when needed).

a changelog is equal to looking at the commit history, so why do you want to dupe the information outside like that?

Ky6uk commented 5 years ago

why do you want to dupe the information outside like that?

Because of a list with short notice about changes is a more convenient and familiar way of getting information about main changes than reading commits history and digging a code inside? 😐

Hypnosphi commented 5 years ago

@Ky6uk he clearly stated that he doesn't care about your convenience: https://github.com/avoidwork/filesize.js/issues/95#issuecomment-537302166

Ky6uk commented 5 years ago

Ahh, nvm then.

avoidwork commented 5 years ago

@Hypnosphi you're right, i don't care about your convenience or @Ky6uk, because you're not paying for my time. I give this freely, and if you want to see something amended to it, use that passion to achieve what you want.

avoidwork commented 5 years ago

btw, you should always be reading the code. never trust someone else's code.