Why this matters
Explicit warnings prevent downstream failures and accelerate coordination.
If an API/contract or behavior is breaking, add a 'BREAKING CHANGE' section detailing what breaks, migration steps, and affected consumers.
Explicit warnings prevent downstream failures and accelerate coordination.
Side-by-side examples engineers can pattern-match during review.
Changed response shape silently.BREAKING CHANGE: /v1/users no longer returns 'age'.
Migration: read 'birthDate' instead.
Consumers: mobile v2, web app.Refactor without noting breakageDedicated BREAKING CHANGE sectionFrom the same buckets as this rule.
If the PR claims to fix a specific issue (e.g., 'Fixes #123' / 'Fix PAY-123'), validate it against the real production error. - If an observability MCP is available (Sentry/Datadog/Bugsnag): fetch the event/stack trace and confirm the change addresses the root cause. - Require a regression test (or a clearly documented reason why a test cannot be added). Call out fixes that only hide symptoms (catch-and-ignore, broader retries, defaulting values) without removing the underlying failure mode.