Skip to content

Clarify AGENTS.md policy on compat shims for breaking changes#2823

Merged
maxisbey merged 1 commit into
mainfrom
docs/agents-md-shim-policy
Jun 9, 2026
Merged

Clarify AGENTS.md policy on compat shims for breaking changes#2823
maxisbey merged 1 commit into
mainfrom
docs/agents-md-shim-policy

Conversation

@maxisbey

@maxisbey maxisbey commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Reword the branching-model section of AGENTS.md: instead of banning @deprecated shims and backward-compat layers outright on main, state that removing or replacing an API must be intentional, and that adding a replacement API or @deprecated shim 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.md entry 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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

AI Disclaimer

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.
@maxisbey maxisbey enabled auto-merge (squash) June 9, 2026 15:02
@maxisbey maxisbey merged commit 6d0c160 into main Jun 9, 2026
31 checks passed
@maxisbey maxisbey deleted the docs/agents-md-shim-policy branch June 9, 2026 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants