Add backward-compatibility guardrail to AGENTS.md#3588
Draft
triple0t wants to merge 2 commits into
Draft
Conversation
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.
What
Adds an
AGENTS.mdwith a Backward Compatibility section. It tells AI coding agents and contributors to treat any change to a public or externally exposed signature — classes, interfaces, methods, hooks, REST endpoints — as high-risk, and to state the backward-compatibility impact in the PR description. It also warns against implementing or type-hinting WooCommerce coreInternal\APIs, which core may change in any release.Why
This plugin runs on live merchant stores, and its public surface is used by other extensions, themes, and site code. A silent change to a shared signature can fatal those consumers on load. WooCommerce Core added the same guardrail after such a change forced a release to be reverted; this brings the plugin in line.
Docs-only change — no runtime code is affected.