File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 44
55<!-- TODO: drop this section once v2 ships and main becomes the stable line -->
66
7- - ` main ` is currently the V2 rework. Breaking changes are expected here — when removing or
8- replacing an API, delete it outright and document the change in
9- ` docs/migration.md ` . Do not add ` @deprecated ` shims or backward-compat layers
10- on ` main ` .
7+ - ` main ` is currently the V2 rework.
8+ - Breaking changes are expected here — removing or replacing an API must be
9+ intentional. Adding a replacement API or ` @deprecated ` shim must likewise be
10+ a deliberate design choice, not bolted on for free.
11+ - Breaking changes (including those softened by a backwards-compatibility
12+ shim) must be documented in ` docs/migration.md ` .
1113- ` v1.x ` is the release branch for the current stable line. Backport PRs target
1214 this branch and use a ` [v1.x] ` title prefix.
1315- ` README.md ` is frozen at v1 (a pre-commit hook rejects edits). Edit
@@ -117,7 +119,8 @@ What the existing pragmas mean:
117119
118120## Breaking Changes
119121
120- When making breaking changes, document them in ` docs/migration.md ` . Include:
122+ When making breaking changes, document them in ` docs/migration.md ` — including
123+ changes softened by a backwards-compatibility shim. Include:
121124
122125- What changed
123126- Why it changed
You can’t perform that action at this time.
0 commit comments