Add Cloud Design Patterns instructions for distributed systems…#942
Add Cloud Design Patterns instructions for distributed systems…#942fatihdurgut wants to merge 1 commit intogithub:stagedfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a new instruction file that provides GitHub Copilot with comprehensive guidance on 42 industry-standard cloud design patterns for distributed systems architecture. The instruction file covers patterns organized into seven categories (Reliability & Resilience, Performance, Messaging & Integration, Architecture & Design, Deployment & Operational, Security, and Event-Driven Architecture), each with problem statement, solution, when-to-use guidance, and implementation considerations. The accompanying docs/README.instructions.md entry is updated to register the new instruction in the catalog.
Changes:
- New
instructions/cloud-design-patterns.instructions.mdinstruction file covering 42 cloud design patterns across 7 categories - Updated
docs/README.instructions.mdto register the new instruction with install badges in alphabetical order
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
instructions/cloud-design-patterns.instructions.md |
New instruction file with front matter (description, applyTo) and content covering cloud design patterns |
docs/README.instructions.md |
Added catalog entry for the new instruction in the correct alphabetical position |
The only issue found is a minor discrepancy between the per-category pattern counts claimed in the PR description and the actual counts in the file (while the total of 42 is correct). This does not affect the quality or correctness of the instruction file itself.
| --- | ||
| description: 'Cloud Design Patterns for distributed systems architecture' | ||
| applyTo: '**/*.bicep, **/*.tf, **/*.cs, **/*.java, **/*.py, **/*.js, **/*.ts, **/*.go, **/architecture.md, **/design.md, **/README.md' | ||
| --- |
There was a problem hiding this comment.
The PR description claims "Reliability & Resilience Patterns (13 patterns)" and "Performance Patterns (11 patterns)" and "Architecture & Design Patterns (9 patterns)" and "Deployment & Operational Patterns (6 patterns)", but the actual counts in the file differ significantly:
- Reliability & Resilience: 9 patterns (not 13)
- Performance: 10 patterns (not 11)
- Architecture & Design: 7 patterns (not 9)
- Deployment & Operational: 5 patterns (not 6)
The overall total of 42 patterns is correct, but the per-category breakdown in the PR description is inaccurate.
|
I'm not sure if an instructions file is the best choice for this, it might make more sense to be a skill for the agent to use. Instructions are included on every interaction, so this will add a considerable number of tokens into them, reducing the amount of context window that can be used for direct contextual information. Converting this to a skill would allow the agent to opt-in to using it as needed, and it could be also sliced up with references in the skill for the different parts so that the agent pulls in the expanded context on an as-needed basis. |
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.Description
This PR adds a new instruction file for Cloud Design Patterns that provides comprehensive guidance on 42 industry-standard design patterns for distributed systems architecture.
The instruction file covers patterns from the Microsoft Azure Architecture Center and is organized into the following categories:
Reliability & Resilience Patterns (13 patterns) - Ambassador, Bulkhead, Circuit Breaker, Compensating Transaction, Retry, Health Endpoint Monitoring, Leader Election, Saga, Sequential Convoy, and more
Performance Patterns (11 patterns) - Asynchronous Request-Reply, Cache-Aside, CQRS, Index Table, Materialized View, Priority Queue, Queue-Based Load Leveling, Rate Limiting, Sharding, Throttling
Messaging & Integration Patterns (7 patterns) - Choreography, Claim Check, Competing Consumers, Messaging Bridge, Pipes and Filters, Publisher-Subscriber, Scheduler Agent Supervisor
Architecture & Design Patterns (9 patterns) - Anti-Corruption Layer, Backends for Frontends, Gateway Aggregation, Gateway Offloading, Gateway Routing, Sidecar, Strangler Fig
Deployment & Operational Patterns (6 patterns) - Compute Resource Consolidation, Deployment Stamps, External Configuration Store, Geode, Static Content Hosting
Security Patterns (3 patterns) - Federated Identity, Quarantine, Valet Key
Event-Driven Architecture Patterns (1 pattern) - Event Sourcing
Each pattern includes:
Problem statement
Solution description
When to use guidance
Implementation considerations with Azure-specific recommendations
The instruction applies to infrastructure code (Bicep, Terraform), application code (C#, Java, Python, JavaScript/TypeScript, Go), and architecture documentation files.
Type of Contribution
Additional Notes
The instruction file is technology-agnostic and can be applied across Azure, other cloud platforms, on-premises setups, and hybrid environments
Content sourced from official Microsoft Learn documentation: https://learn.microsoft.com/en-us/azure/architecture/patterns/
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.