Repository navigation
docs(agents): write down the versioning policy - #352
Merged
Merged
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
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.
Closes #323.
Adds a Versioning section to
AGENTS.mdand removes the "public rename ships a silent alias" rule from Code style. Since #350 and #351, renamed names and config fields warn, so the old rule and itsOpentelemetryConfigexample no longer matched the code.The section records four rules:
DeprecationWarningfor at least one minor and is deleted in the next major, with pointers todeprecated_module_getattrandBaseConfig._renamed_fields;One deviation from the issue text: the issue lists "raised floors" as breaking without qualification. Floors have been corrected in patch releases (#259, #300, #328) because the old floor never worked. The rule treats only raising a floor that the code ran correctly with as breaking, and calls a correction a fix.
Verified:
just adr-checkpasses, and lychee in the CI job's offline mode reports no broken links inAGENTS.md.