docs: expand pattern coverage catalog#216
Merged
Merged
Conversation
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
Test Results 1 files 1 suites 2m 16s ⏱️ Results for commit 71999bd. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #216 +/- ##
==========================================
+ Coverage 91.95% 96.66% +4.70%
==========================================
Files 255 255
Lines 23842 24024 +182
Branches 3270 3270
==========================================
+ Hits 21925 23223 +1298
+ Misses 858 801 -57
+ Partials 1059 0 -1059
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
There was a problem hiding this comment.
Pull request overview
This PR expands PatternKit’s “pattern coverage catalog” beyond the canonical GoF set to include enterprise integration, messaging reliability, and application-architecture patterns, and updates docs/tests to treat GoF as a baseline subset.
Changes:
- Extends the pattern catalog (
PatternKitPatternCatalog) with enterprise integration, reliability, and CQRS entries (including tracked generator gaps). - Updates production-readiness tests to validate both the GoF baseline and the expanded enterprise/architecture catalog.
- Updates documentation to describe the broader research baselines and the expanded coverage matrix.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| test/PatternKit.Examples.Tests/ProductionReadiness/PatternKitPatternCatalogTests.cs | Updates catalog validation to cover both GoF baseline and new enterprise/architecture additions, plus tracked generator gaps. |
| src/PatternKit.Examples/ProductionReadiness/PatternKitPatternCatalog.cs | Expands the catalog model (new families) and adds new catalog entries for enterprise integration/reliability/CQRS patterns. |
| docs/guides/pattern-coverage.md | Updates the guide to describe broader catalog scope and adds an enterprise/architecture coverage table. |
| docs/examples/production-ready-integrations.md | Updates narrative to reflect the broader catalog and tracked generator-gap expectations. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "https://github.com/JerrettDavis/PatternKit/issues/212", | ||
| "docs/generators/dispatcher.md", | ||
| "src/PatternKit.Examples/MediatorComprehensiveDemo/ComprehensiveDemo.cs", | ||
| "test/PatternKit.Examples.Tests/MediatorDemo/MediatorDemoTests.cs", |
Contributor
Code Coverage |
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. |
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\n- broaden the pattern coverage catalog beyond GoF into enterprise integration, messaging reliability, and application architecture patterns\n- keep the canonical GoF checks as a subset baseline\n- add audited catalog entries for message envelope, content router, recipient list, splitter, aggregator, routing slip, saga/process manager, mailbox, idempotent receiver, inbox, outbox, request/reply, publish/subscribe, and CQRS\n- document the broader research baselines and tracked generator gaps\n\n## Research baselines\n- Enterprise Integration Patterns catalog: https://www.enterpriseintegrationpatterns.com/patterns/messaging/index.html\n- Fowler PoEAA catalog: https://martinfowler.com/eaaCatalog/\n- Microsoft cloud design patterns: https://learn.microsoft.com/azure/architecture/patterns/\n- Domain Event pattern: https://microservices.io/patterns/data/domain-event.html\n\n## Tracking issues created\n- #209 Mailbox generator\n- #210 Recipient List generator\n- #211 Splitter/Aggregator generators\n- #212 CQRS example\n- #213 reliability generators\n- #214 request/reply and pub/sub backplane generators\n- #215 message envelope contract generator\n\n## Validation\n- git diff --check\n- catalog path existence check\n- dotnet test test/PatternKit.Examples.Tests/PatternKit.Examples.Tests.csproj -c Release --no-restore (blocked locally by existing CS9057 compiler/analyzer mismatch; CI has the authoritative SDK)