Skip to content
BENIBIX Learn

Breaking Change

Development🚀 Product & ReleasesReleases

Also known as Breaking Update, Incompatible Change, Backwards-Incompatible Change

A change that makes code built on the old version stop working.

Think of it like

Think of it like moving the light switch to the other wall. Everyone who reaches for the old spot hits the wall.

Example

Emma's API renames the field user_name to username. Every app that read the old name now shows a blank. She should have called it version 2.

Why it matters

Others build on your code. An unwarned break can take down apps you have never heard of.

Definition

A breaking change is a change that makes code which used the old version stop working. Renaming a function, removing an option or changing what a reply looks like can all break things. The people affected must change their own code to update. Under semantic versioning, a breaking change needs a new major version. Good teams warn first, give a way to move over, and list it clearly.

Common mistake

Thinking a small rename is harmless. If anyone else's code uses the old name, it is a breaking change.

Key takeaways

  1. 1
    Old code stops working. Users must change theirs.
  2. 2
    Needs a major version. Under semantic versioning.
  3. 3
    Warn first. And give a way over.