Please add a CHANGELOG
Closed this issue · 10 comments
And a migration guide from 5.x to 6.x if changes are needed.
Based on the blurb in the README, "completely redesigned" comes off as a red flag that changes might be needed but you didn't provide any additional context.
Agree, the documentation is so confusing, I have no idea how to set isSticky for the 6.x,
automatically become sticky HOC?
The demo is too simply and useless
Sorry to hear you find the demo useless @chuanxie. If you have suggestions as to how to improve it, create an issue with what you'd like to see. I can't promise I'll do it, but somebody else might.
Unfortunately, I personally don't have the time to create a CHANGELOG. I also don't think that this is a prohibitively difficult API to understand. Just read the docs and do some experimentation and that should be sufficient to get you where you need to be in a short amount of time.
If someone wanted to make a PR containing a CHANGELOG or similar, perhaps via documenting their own upgrade from 5.x to 6.x, I would accept it.
It need to add style={style} to make it sticky. I don't know how demo work without setting style attribute @dbarbalato
@dbarbalato Here's the thing, if every library that goes into a frontend project took your philosophy, it would literally takes weeks to upgrade things because FE is generally a land of tiny, specific modules. It's not really acceptable to have to grok a codebase's entire source to understand in the event of an upgrade one small thing changed but the rest is the same. That's simply developer-hostile.
As far as "time to maintain a changelog" goes, it takes perhaps 5 minutes when you're cutting a release to put together a short guide on the major changes. I am also a module author and don't find this to be a prohibitive amount of time investment, the same as the vast majority of others.
Would you be interested in submitting a PR, @evan-scott-zocdoc ? I've never done a CHANGELOG and it sounds like you've done a few - I'd be happy to advise you on the high level details if you needed them but as I said, I'm too busy and not particularly motivated at the moment to sit down and do it myself.
If not, that's cool too - that same offer stands for anyone interested in contributing
A migration guide will be very vital. I saw examples watch docs and I'm still unable to migrate after few hours.
Since I'm taking over maintenance and have no familiarity with the API < 6.0.0, I'm going to close this. If somebody wants to document the changes they had to make in order to upgrade I would be happy to work together to add it to the docs, but it's not something I'm able to do on my own.
You should probably leave it open then if you want to allow people to tag on and help :p
It's 9 month old issue with no activity. Happy to reopen if somebody volunteers.
Comments are still open! But old issues with no activity make a project look inactive, I'm biased towards closing aggressively and reopening if needed.