Stop framing breaking changes as a workflow in AGENTS.md - #3286
Draft
maxisbey wants to merge 1 commit into
Draft
Conversation
The Branching Model bullets and the "Breaking Changes" section were written while v2 was still being assembled, and read as instructions for making a breaking change: be intentional about it, then write it up in docs/migration.md. With 2.x released that nudges the wrong way. State the 2.x compatibility contract in one bullet, mark docs/migration.md as closed to new entries, and drop the Breaking Changes section, which only existed to describe how to add to that file. No-Verification-Needed: contributor-guidance doc only
maxisbey
changed the title
maxisbey
force-pushed
the
docs/agents-api-stability
branch
from
August 16, 2026 12:49
e5b1d03 to
eb43bb6
Compare
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
1 participant
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.
Rewords the two places in
AGENTS.mdthat still framed breaking changes as a documented workflow, now that 2.x is the released stable line.Motivation and Context
The Branching Model bullets ("removing or replacing an API must be intentional… changes that break code written against v1 must be documented in
docs/migration.md") and the## Breaking Changessection were written while v2 was being assembled. Read today they nudge an agent toward "breaking public API is fine as long as it's written up in the migration guide", and treatdocs/migration.mdas a live document to append to.This PR states the 2.x compatibility contract in one bullet (changes to existing public API are an explicit maintainer decision and generally avoided), marks
docs/migration.mdas the finished v1 → v2 record that's closed to new entries, and drops the## Breaking Changessection, which only existed to describe how to add to that file.How Has This Been Tested?
pre-commit run --files AGENTS.md(markdownlint) passes. No code changes.Breaking Changes
None.
Types of changes
Checklist
Additional context
CONTRIBUTING.mdstill tells human contributors thatmaintakes "New APIs, refactors" with no stability caveat; left for a follow-up so this stays scoped to agent guidance.