docs(experimental): establish [Experimental] API convention + FALLOUT0xx registry - #316
Merged
Merged
Conversation
…0xx registry
Implements ADR-0004 §5. Documents the [Experimental("FALLOUT0xx")] opt-in
convention for unstable public APIs: the System.Diagnostics.CodeAnalysis
attribute (BCL, no package), sequential never-reused diagnostic IDs, the
consumer suppression opt-in, promote-to-stable = remove-the-attribute, and the
edge-vs-stable-train channel discipline. Adds a diagnostic-ID registry at
docs/experimental-apis.md (seeded empty) and an AGENTS.md pointer near rule #2.
Docs-only: no [Experimental] applied to any existing API.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
ChrisonSimtian
added
documentation
This was referenced Aug 7, 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
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.
Establishes the
[Experimental]opt-in convention for unstable public APIs, per ADR-0004 §5. PR 4 of the ADR-0004 rollout.What this adds
docs/agents/conventions.md— a focused[Experimental] for opt-in unstable APIssection: useSystem.Diagnostics.CodeAnalysis.ExperimentalAttribute(BCL, .NET 8+, no package reference needed since we target .NET 10); theFALLOUT0xxdiagnostic-ID scheme (sequential, never reused); consumers must explicitly suppress the error-by-default diagnostic (#pragma warning disable FALLOUT001or<NoWarn>) to opt in; promoting to stable = removing the attribute (no cross-branch cherry-pick); and the channel discipline (courtesy on edge/main, mandatory on arelease/YYYYstable train). Adding/removing[Experimental]is not a breaking change.docs/experimental-apis.md— a new consumer-facing diagnostic-ID registry: how-it-works, the allocation scheme, and theFALLOUT0xxtable. Seeded empty (no IDs allocated yet); the first experimental API to land claimsFALLOUT001.AGENTS.md— a one-line pointer to both docs from rule Enterprise hardening: repo nuget.config breaks corporate packageSourceMapping setups #2 (which already mentions[Experimental]).Scope
Docs-only. No
[Experimental]attribute was applied to any existing API — doing so speculatively would break the build wherever those APIs are referenced internally (the diagnostic is error-by-default). The convention is established; allocation happens per-API as real unstable surface lands. No code touched, so the build is unaffected.🤖 Generated with Claude Code