Improve testing and operational documentation#122
Draft
Reefact wants to merge 8 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
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
This PR separates everyday error assertions from deterministic occurrence testing, and separates catalog delivery from runtime logging integration. The resulting guides give each concern a focused mental model, concrete examples, and review checklists without changing library behavior.
Type of change
Changes
ShouldSucceed(),ShouldFail(),ErrorAssertion, and targeted behavioral assertions.Clock,InstanceIds, custom sources, snapshots, scope lifetime, and parallel-test behavior.InnerErrors, occurrence correlation, catalog links, log-level guidance, and sensitive-data rules.Testing
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)No build or test command was run because this PR changes Markdown documentation only. The examples were reviewed against the documented
FirstClassErrors.Testing,Error,DiagnosableException, and catalog CLI APIs, and the cross-page navigation was reviewed manually.Documentation
doc/updateddoc/README.fr.md) updated if user-facing behavior changedThe French counterpart of every changed or added English page is included.
doc/README.fr.mditself did not require a change because the existing testing and operational-integration entries remain the entry points and now link to the new focused guides.Related issues
None.