Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[API] 1.1.1 Introduces significant breaking changes without deprecation warnings #43

Closed
Nek-12 opened this issue Mar 26, 2023 · 1 comment

Comments

@Nek-12
Copy link

Nek-12 commented Mar 26, 2023

Some breaking changes (SheetState -> UseCaseState and rememberSheetState -> rememberUseCaseState, removal of the CalendarTimeline) were introduced in 1.1.1 version without any of these indications about breaking changes:

  1. Bumping a major version
  2. Introducing deprecation warnings first
  3. Providing typealiases
  4. Providing an alpha-suffixed version with changes
  5. Providing a documented migration path

This led to significant amount of build failures in our project upon upgrading.

Suggestion:
Next time, as this library is stable now, please give users time to migrate to the new API by using a combination of the common practices mentioned above.

@maxkeppeler
Copy link
Owner

Given the extensive scope of the library and the limited free time available to most adults, I have decided not to include deprecation warnings or alpha versions. Although changes were communicated in the release notes, I acknowledge that I could have been more specific about breaking changes and provided migration guides alongside major dependency version upgrades. Rest assured, I will strive to improve my communication in the future to make it easier for devs to adapt to any changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants