Versioning and Changelog
nadar opened this issue · comments
Hi
Its a great project, we use that library, its great 👍 thanks for all the work!
We are not sure what the versioning concept of this library looks like, also we could not find information about what has changed (a changelog), there are only tags: https://github.com/spekulatius/PHPScraper/tags. So it would be nice to read something about what is the versioning strategy and when are breaks expected.
Of course semver would be nice with an 1.0.0 release and a CHANGELOG.md and UPGRADE.md. My personal example would look like this https://github.com/nadar/quill-delta-parser/blob/master/CHANGELOG.md and this https://github.com/nadar/quill-delta-parser/blob/master/UPGRADE.md
Thanks and keep up to great work!
Hey @nadar,
thank you for your message. Great to hear it's useful for you! 🤩
I can see that the development process isn't overly clear atm. The main principle -so far- has been release early, release often.
The lib should follow semver, unless I missed something. I'll add a changelog and upgrade instructions with the next general update of the readme. Good idea 👍 It should come soon(ish).
Feel free to share any other feedback or ideas you might have :)
Cheers,
Peter
Should i send a PR with those files? Is there a reason for starting versioning with 0? I would recommend a 1.0 release:
Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.
Should i send a PR with those files?
All good, it needs to be build up with actual information.
Is there a reason for starting versioning with 0?
0.x is correct - while usable it's still in (heavy) development. I'm avoiding breaking changes as good as possible to allow early adopters to use it. 1.0 comes once the feature set is completed.
All right, i understand. So there would be nice to see a roadmap of what is missing 😄
2 1/2 years of development and 16k downlods. I would consider this as a feature rich, first stable release :-)
Yeah, it's been a while :D I didn't even notice it's 16k downloads already. That's quite a bit more than I expected 🤩
I'm on the push to 1.0 💪 I'll make sure to get the roadmap and docs updated before 👍
Hey @nadar
I've added a CHANGELOG.md and UPGRADING.md (still empty). Feel free to let me know if you have any feedback :)
Cheers,
Peter
Today we recieved an update, but could not find something in changelog or releases (it seems to be a tag 1.0.1)
Hey @nadar,
Thanks for the reminder. I've added it in. Let me know if any questions come up.
Cheers,
Peter