Skip to content

Commit 1f20eac

Browse files
committed
add feature flags, reword codemods
1 parent abdf1c1 commit 1f20eac

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

develop-docs/sdk/processes/breaking_changes.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,9 @@ Fortunately, there is always a lot you can do (and not do) to make the upgrade p
9696

9797
- Call-outs in relevant places in the docs and in the changelog.
9898
- Deprecation warnings that a breaking change is coming.
99-
- Supporting an intermediate period where both the old and the new way of doing things works.
100-
- A polished migration guide with a lot of easily copy-pastable before-and-after examples.
101-
- Trying to do the upgrade yourself on a test app. Instruct an LLM to do the update using your migration guide and see how well it works.
102-
- Providing a tool that helps with the upgrade, for example using codemods.
99+
- Support an intermediate period where both the old and the new way of doing things works.
103100
- Maintain deprecated APIs, if possible, for another major version.
101+
- Add an SDK option that acts as a feature flag to enable users to switch between the old and the new behavior.
102+
- A polished migration guide with a lot of easily copy-pastable before-and-after examples.
103+
- Try to do the upgrade yourself on a test app. Instruct an LLM to do the update using your migration guide and see how well it works.
104+
- Provide a tool that helps with the upgrade, for example using codemods. (Caveat: This is tricky to get right so that it covers all possible usages of the SDK.)

0 commit comments

Comments
 (0)