Repository navigation
docs(metrics,logging,xunitv3): address #161 preview.128 dogfood follow-up (PLAN-0076) - #183
Merged
Merged
Conversation
…w-up (PLAN-0076)
Codex Review Summary: ✅ CompletedThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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.
Summary
Implements PLAN-0076 from RESEARCH-0041, the documentation-only follow-up to the preview.128 dogfood findings on #161.
Related to #161. This PR does not close the issue; remaining issue scope is tracked separately.
Changes (D1-D5)
CompositionExceptionsample to include "configuration rule"; addedIMeterFactory→UseMetrics()andILogger/ILogger<T>→UseLogging()guidance in troubleshooting, package guides, and skill references; cross-linked the existing Metrics misuse entry.TConfig: keptbuilder.Register(() => config)plus a composedTConfigparameter as the primary recipe; added an optional consumer-sideConfigProfile<TConfig>base-profile note (not a Compono type/API) in the cookbook, xUnit v3 guide, and skill reference.[Shared]vsShare<IMeterFactory>(): removed the redundantShare<IMeterFactory>()from the lead[Shared]example and documented them as alternatives (per-test vs profile-wide/undecorated/Composer.Create), including why sharing matters.ComposeDatafailure counts: documented the whole-theory failure contract in the xUnit v3 guide, AOT guide, troubleshooting, and skill reference: all rows compose before any run, one failure stops the rest, and the theory reports a single failed result.New tests
OptionalBaseProfile_RegistersRowConfig_ForAComposedParameter— backs the optional base-profile recipe with distinct per-row configs and a SUT that consumes the composed config.SharedParameter_DeclaredAfterDependent_IsSharedAcrossTwoNestedConsumers— proves[Shared]works when declared after the dependent and is shared across two nested consumers withoutShare<T>().NestedConsumers_GetIndependentFactories_WithinOneRoot_AbsentShared— backs the no-sharing claim for nested consumers in oneComposer.Creategraph.Validation
Compono.XunitV3.Tests: 339 passed per TFM;Compono.Metrics.Tests: 105-106 passed per TFM on net8.0-net11.0.git diff -- src/is empty.Scope
No production source or public API changes. Packaging, ApiCompat, and Native AOT publishing checks were not run because no shipped assembly, package contents, or public surface changed; this PR is documentation, skill/evals, and example-backing tests only. No AOT test was added because the optional base-profile snippet is not in AOT docs.