Practise writing breaking change announcements, migration guides, and deprecation notices in clear technical English.
0 / 5 completed
1 / 5
Which phrase best opens a breaking change announcement?
A good breaking change announcement immediately identifies: the version, what changed (authentication API), and what action is required (review migration guide).
2 / 5
A deprecation notice should include:
Good deprecation notices include: what is deprecated, why, what to use instead, and when the deprecated feature will be removed — giving developers everything they need to migrate.
3 / 5
The phrase 'this method is deprecated and will be removed in v5.0' means:
Deprecated means marked for future removal but still functional. Developers should migrate away from it before v5.0 — it continues to work in the current version.
4 / 5
A migration guide for a breaking change should include:
Migration guides with concrete before/after code examples are most effective — developers can immediately see what to change without having to infer the new API from documentation.
5 / 5
What does 'codemods' mean in the context of breaking changes?
Codemods are automated code transformation scripts (often using jscodeshift) that migrate large codebases from an old API to a new one — reducing the burden of breaking changes.