search

Mevrael / bunny

BunnyJS - Lightweight native (vanilla) JavaScript (JS) and ECMAScript 6 (ES6) browser library, package of small stand-alone components without dependencies: FormData, upload, image preview, HTML5 validation, Autocomplete, Dropdown, Calendar, Datepicker, Ajax, Datatable, Pagination, URL, Template engine, Element positioning, smooth scrolling, routing, inversion of control and more. Simple syntax and architecture. Next generation jQuery and front-end framework. Documentation and examples available.
https://bunnyjs.com
MIT License
487 stars 39 forks source link

introduce a changelog #17

Closed skwakman closed 7 years ago

skwakman commented 7 years ago

Hi!

Currently it's hard to find out what things have changed between BunnyJS versions and if a new version introduced a breaking change. Perhaps it's a good idea to introduce a changelog file?

Mevrael commented 7 years ago

Hi @skwakman

Thank you for your interest in BunnyJS and feedback.

You are absolutely right. In the ideal situation every release should be released with a tags and a full changelog description, however, it requires much more human resources I have right now. So making a simple CHANGELOG.md probably for now would be a good idea.

However, it would be great if you could help me understand which components are used by community and requires a changelog on the first place. Regarding all the components which already have official examples and/or documentation - they don't receive any critical changes, so it is important for me to know on which other components/helpers I should focus first when writing changelog.

Thanks again, if you will have some time to share your experience with BunnyJS, codebase and architecture so far, it would be great and could help making this product better and simpler for everyone.

skwakman commented 7 years ago

Hi @Mevrael,

Currently I'm only using BunnyJS' form validation components, however other user might want to know about changes in different components as well.

My primary concern here is finding out what changed between BunnyJS versions so I can test if my usage of these components won't break anything. Although non-critical changes should not introduce any bugs, there's always that one use case that nobody thought of.

In future updates, a short per-version overview of which components were changed and if the changes should not break anything should suffice. If you're using github's issue tracking, a (auto-generated?) list of closed issues per version could work as well.

Mevrael commented 7 years ago

Thank you for comments.

If there are any important changes in the already documented components then they are obligatory posted on my Twitter account or in GitHub release message.

Regarding Form Validation component please take into account this post https://twitter.com/Mevrael/status/820678938838102017 (I will also post a release note what needs to be changed when I will have time to update those classes in default settings)

Please follow me on Twitter to receive all the important information regarding the upcoming changes in BunnyJS as well. You also may join and follow our Gitter channel https://gitter.im/bunny-js/Lobby