[Suggestion] Continue Semantic Versioning and Include a Changelog
andrekutianski opened this issue · comments
Hello,
I've been using the bigbluebutton-api-php project and I've noticed that semantic versioning of the packages has been discontinued and there is no changelog present in the project.
Semantic versioning is a standard practice that helps maintain clarity and predictability in the software's evolution. It follows the MAJOR.MINOR.PATCH format, where:
- MAJOR version increments when there are incompatible API changes,
- MINOR version increments when functionality is added in a backwards-compatible manner,
- PATCH version increments when backwards-compatible bug fixes are made.
This allows users of the package to understand the type of changes that are being made between each version and can plan their updates accordingly.
In addition, a changelog is a file that contains a curated, chronologically ordered list of notable changes for each version of a project. This would allow the community to easily follow the evolution of the package, understand what changes have been made in each version, and plan their updates accordingly.
By adopting semantic versioning and a changelog, we can improve communication about changes in the project and make it easier for the community to keep track of the package's evolution.
I hope you'll consider this suggestion, and I am available to collaborate. Thank you for your time and for the great work on this project!
@andrekutianski All help is welcome. We want to keep things very simple and easy.