Prompt file imported from r4topunk/vibe-three (
.github/prompts/guild/pattern-library/pattern-template.prompt.md). Copyright stays with the author.
[Pattern Name]
Category: [Architectural | Design | Integration | Implementation | Process]
Status: [Candidate | Emerging | Established | Core]
Last Updated: [YYYY-MM-DD]
Contributors: [Names of key contributors]
Problem Statement
[A clear, concise description of the problem this pattern addresses. What are the symptoms that indicate this problem exists? Why is it important to solve?]
Context
[The situations or circumstances in which this pattern applies. What are the preconditions? What forces are at play that make this problem challenging?]
Solution
[A detailed description of the solution approach. This should be specific enough to implement but not overly prescriptive about implementation details that don't matter.]
Key Components
[Break down the solution into its essential components or steps]
Implementation Guidelines
[Practical advice for implementing the pattern correctly]
Example Implementation
[Code or pseudo-code example showing the pattern in action]
Consequences
[The results, both positive and negative, of applying this pattern]
Benefits
- [Benefit 1]
- [Benefit 2]
- [Benefit 3]
Tradeoffs
- [Tradeoff 1]
- [Tradeoff 2]
- [Tradeoff 3]
Related Patterns
- [Pattern 1]: [Brief explanation of relationship]
- [Pattern 2]: [Brief explanation of relationship]
- [Pattern 3]: [Brief explanation of relationship]
Known Uses
[Specific examples of where this pattern has been successfully applied in the codebase]
- [Example 1]: [Link or reference to implementation]
- [Example 2]: [Link or reference to implementation]
- [Example 3]: [Link or reference to implementation]
Variations
[Significant variations of this pattern that might be applicable in different contexts]
Testing Considerations
[How to effectively test implementations of this pattern]
Evolution History
[How this pattern has evolved over time]
References
[External or internal references that provide more information about this pattern]
Review Notes
[Internal notes about the pattern review process, can be removed before publication]