Skip to content

docs: document analyzer audit baseline #400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JerrettDavis merged 1 commit into from
May 28, 2026
Merged

docs: document analyzer audit baseline #400

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/guides/quality-gates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ Every production pattern should have:

The repository includes a root `.editorconfig` so editors, `dotnet format`, and CI agree on basic C# layout and style. Run `dotnet format PatternKit.slnx --verify-no-changes --verbosity minimal` before opening a PR; CI enforces the same gate for pull requests and `main` releases.

The same rule applies to analyzer hardening. Built-in .NET analyzers currently surface many intentional API-shape warnings for fluent generic factories, benchmark method names, and netstandard-compatible guard code. Enable stricter analyzers by project and rule family with explicit baselines rather than turning on solution-wide warning enforcement in one step.
Built-in .NET analyzers can be audited with `/p:EnableNETAnalyzers=true /p:AnalysisLevel=latest /p:AnalysisMode=Recommended /p:EnforceCodeStyleInBuild=true`. That audit currently surfaces project-specific baselines, including source-generator workspace gaps in examples and benchmarks, fluent API shape warnings in production code, benchmark naming warnings, and culture-sensitive string assertions in generator tests. Enable stricter analyzer families by project with explicit baselines rather than turning on every optional rule at once.
Loading