Clarify AGENTS.md policy on compat shims for breaking changes#2823
Merged
Conversation
The branching-model section banned @deprecated shims outright. The actual policy is that removal is the default and a shim is allowed as a deliberate design choice. Also make explicit that shimmed breaking changes still need a docs/migration.md entry, and echo that in the Breaking Changes section.
felixweinberger
approved these changes
Jun 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reword the branching-model section of AGENTS.md: instead of banning
@deprecatedshims and backward-compat layers outright onmain, state that removing or replacing an API must be intentional, and that adding a replacement API or@deprecatedshim must likewise be a deliberate design choice rather than something bolted on by default.Motivation and Context
The old wording read as an absolute rule, but sometimes a shim is the right call during the v2 rework — it just has to be a conscious decision. This also makes explicit that a breaking change still needs a
docs/migration.mdentry even when a compat shim softens it, and echoes that in the Breaking Changes section so it's visible to readers who jump straight there.How Has This Been Tested?
Docs-only change; pre-commit (markdownlint) passes.
Breaking Changes
None.
Types of changes
Checklist
AI Disclaimer