Major version upgrade guide

[CAYdenberg]

Description

I had to bump this package to a new major version to fix a production bug (relating to hooks being called conditionally). The release notes are not very helpful in terms of highlighting what changes are considered breaking and what changes I will have to make in my code.

The upgrade made was 2.4.4 -> 3.0.4

Suggested solution or improvement

I suggest publishing a list of release notes for major versions that describe what breaking changes developers need to look out for.

Additional context

No response

Validations

• [X] Follow our Code of Conduct

[fgiuliani]

Hi @CAYdenberg thanks for creating this ticket. Did you have any issues or problems updating React SDK version to 3.0.4?

The reason for the major version bump was a dependency's major version being released: https://github.com/storyblok/storyblok-react/releases/tag/v3.0.0

In theory, no changes would be needed on your code

[CAYdenberg]

No problems that I'm aware of, but it would be great if I knew how carefully to check.

If this bump was due to a major version bump in JS-SDK which was in turn due to a major version bump in js-client, which only added an additional type for export. I do not understand why the addition of a type would be considered a breaking change.