chore: document quality gates baseline#395
Merged
Merged
Conversation
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR establishes a documented baseline for PatternKit quality gates while making shared test assertions friendlier to nullable string inputs.
Changes:
- Adds a root
.editorconfigfor shared C# and documentation formatting settings. - Adds a new quality-gates guide and links it from the guides TOC.
- Updates shared test string assertions and nullable warning baselines in test projects.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
.editorconfig |
Defines baseline formatting and style settings. |
docs/guides/quality-gates.md |
Documents local validation, TinyBDD expectations, package checks, formatting, and analyzer baseline policy. |
docs/guides/toc.yml |
Adds the new Quality Gates guide to the guides navigation. |
test/ScenarioExpect.cs |
Allows selected string assertion helpers to accept nullable actual strings safely. |
test/PatternKit.Tests/PatternKit.Tests.csproj |
Adds nullable-flow warning suppressions to the test baseline. |
test/PatternKit.Generators.Tests/PatternKit.Generators.Tests.csproj |
Adds a nullable dereference warning suppression to the generator test baseline. |
test/PatternKit.Examples.Tests/PatternKit.Examples.Tests.csproj |
Adds a nullable dereference warning suppression to the examples test baseline. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -10,7 +10,7 @@ | |||
| CS0618: Tests intentionally use obsolete APIs to verify backward compatibility | |||
| @@ -8,7 +8,7 @@ | |||
| <!-- Suppress warnings: | |||
| @@ -9,7 +9,7 @@ | |||
| CS1591: Missing XML comment (examples don't need docs) | |||
| CS0649: Field never assigned (used in serialization scenarios) | |||
Contributor
Test Results 12 files 12 suites 8m 38s ⏱️ Results for commit 0193aa0. |
Contributor
🔍 PR Validation ResultsVersion: `` ✅ Validation Steps
📊 ArtifactsDry-run artifacts have been uploaded and will be available for 7 days. This comment was automatically generated by the PR validation workflow. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #395 +/- ##
==========================================
+ Coverage 89.56% 95.63% +6.07%
==========================================
Files 530 530
Lines 42899 42899
Branches 6203 6203
==========================================
+ Hits 38421 41027 +2606
+ Misses 2022 1872 -150
+ Partials 2456 0 -2456
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Code Coverage |
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
.editorconfigso editors have a shared baseline for C# and docs formatting.ScenarioExpectstring assertions nullable-safe so tests can assert nullable output without compiler noise.Audit follow-ups opened
Verification
dotnet build PatternKit.slnx --configuration Release --no-restore -m:1dotnet test test\PatternKit.Tests\PatternKit.Tests.csproj --configuration Release --framework net8.0 --no-build --logger "console;verbosity=minimal"dotnet test test\PatternKit.Generators.Tests\PatternKit.Generators.Tests.csproj --configuration Release --framework net8.0 --no-build --logger "console;verbosity=minimal"dotnet test test\PatternKit.Examples.Tests\PatternKit.Examples.Tests.csproj --configuration Release --framework net8.0 --no-build --logger "console;verbosity=minimal"dotnet test test\PatternKit.Hosting.Extensions.Tests\PatternKit.Hosting.Extensions.Tests.csproj --configuration Release --no-build --logger "console;verbosity=minimal" -p:TestTfmsInParallel=falsedocfx docs\docfx.json --warningsAsErrorsdotnet list PatternKit.slnx package --outdatedNotes:
dotnet format PatternKit.slnx --verify-no-changesstill fails on historical formatting; #393 tracks the dedicated mechanical baseline PR. JetBrains InspectCode was not available on PATH in this environment.