search

onOfficeGmbH / sdk

Official client for the onOffice API
https://apidoc.onoffice.de/
MIT License
9 stars 11 forks source link

Roadmap to v1.0.0 #8

Closed legionth closed 3 years ago

legionth commented 4 years ago

This project is currently used in some other projects which are already in production.

We want to follow the release scheme of Semantic Verisioning for upcoming releases. For the v1.0.0 we will intodruce some backwards compatibility breaks in order to create a more fitting consumer expierence in the future. There is currently no intention for v1.0.0 to change the communication with official onOffice API. The intention for this library is to ease the implementation into existing eco-systems.

I set up a roadmap that should adress all major changes for each past and upcoming versions:

v0.1.0 ✅

v0.2.0✅

v1.0.0

This ticket aims to serve as a basic overview and does not contain every single change. Please also see the CHANGELOG for more details.

We try to update this continously.

Please keep the discussions in this ticket to a minimum. So problems can be identified fast and discussed more focused.

Please open an issue if you have further questions or recommandations.

dkaisers commented 4 years ago

That's a good start I think. I would like to add the renaming of the main folder from SDK to src and correcting the casing of the main class in accordance with PSR-12 to the list.

legionth commented 4 years ago

Add a v0.2.0 in between, to create a better experience to add this library. These changes are BC, but according to semver we are still on the major version v0.x.y which can contain BC.

dkaisers commented 4 years ago

We should also probably define a PHP version requirement in the composer.json. I think currently the SDK aims to work against PHP 7 and above.

legionth commented 3 years ago

Since this list confuses some people, we'll close this issue for now.

v0.2.0 is already used in several productive system there is currently no need for breaking changes in the near future.