Skip to content

Commit 49f91b3

Browse files
committed
consistent wording
1 parent 0dff803 commit 49f91b3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

develop-docs/sdk/processes/breaking_changes.mdx

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

9797
### Ways to Lessen Friction
9898

99-
- Call-outs in relevant places in the docs and in the changelog.
100-
- Deprecation warnings that a breaking change is coming.
99+
- Add call-outs in relevant places in the docs and in the changelog.
100+
- Add deprecation warnings that a breaking change is coming.
101101
- Support an intermediate period where both the old and the new way of doing things works.
102102
- Maintain deprecated APIs, if possible, for another major version.
103103
- Add an SDK option that acts as a feature flag to enable users to switch between the old and the new behavior.
104-
- A polished migration guide with a lot of easily copy-pastable before-and-after examples.
104+
- Write a polished migration guide with a lot of easily copy-pastable before-and-after examples.
105105
- 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.
106106
- 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)