Initial commit
This commit is contained in:
69
skills/codify-solution/assets/critical-pattern-template.md
Normal file
69
skills/codify-solution/assets/critical-pattern-template.md
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
pattern_name: {{PATTERN_NAME}}
|
||||
category: {{CATEGORY}}
|
||||
frequency: {{high|medium|low}}
|
||||
severity_when_missed: {{critical|high|medium|low}}
|
||||
created: {{DATE}}
|
||||
instances:
|
||||
- {{SOLUTION_DOC_1}}
|
||||
---
|
||||
|
||||
# Critical Pattern: {{PATTERN_NAME}}
|
||||
|
||||
## Summary
|
||||
|
||||
{{One sentence description of the pattern}}
|
||||
|
||||
## The Pattern
|
||||
|
||||
{{Describe the anti-pattern or mistake that keeps recurring}}
|
||||
|
||||
## Why It Happens
|
||||
|
||||
1. {{Common reason 1}}
|
||||
2. {{Common reason 2}}
|
||||
|
||||
## How to Recognize
|
||||
|
||||
**Warning Signs:**
|
||||
- {{Sign 1}}
|
||||
- {{Sign 2}}
|
||||
|
||||
**Typical Error Messages:**
|
||||
```
|
||||
{{Common error message}}
|
||||
```
|
||||
|
||||
## The Fix
|
||||
|
||||
**Standard Solution:**
|
||||
|
||||
```{{LANGUAGE}}
|
||||
{{Code showing the correct approach}}
|
||||
```
|
||||
|
||||
**Checklist:**
|
||||
- [ ] {{Step 1}}
|
||||
- [ ] {{Step 2}}
|
||||
|
||||
## Prevention
|
||||
|
||||
### Code Review Checklist
|
||||
|
||||
When reviewing code in this area, check:
|
||||
- [ ] {{Item to verify}}
|
||||
- [ ] {{Item to verify}}
|
||||
|
||||
### Automated Checks
|
||||
|
||||
{{Suggest linting rules, tests, or CI checks that could catch this}}
|
||||
|
||||
## Instance History
|
||||
|
||||
| Date | Solution Doc | Component |
|
||||
|------|--------------|-----------|
|
||||
| {{DATE}} | [{{title}}]({{path}}) | {{component}} |
|
||||
|
||||
## Related Patterns
|
||||
|
||||
- {{Link to related pattern}}
|
||||
89
skills/codify-solution/assets/resolution-template.md
Normal file
89
skills/codify-solution/assets/resolution-template.md
Normal file
@@ -0,0 +1,89 @@
|
||||
---
|
||||
date: {{DATE}} # Format: YYYY-MM-DD (e.g., 2025-01-27)
|
||||
problem_type: {{PROBLEM_TYPE}}
|
||||
component: {{COMPONENT}}
|
||||
symptoms:
|
||||
- "{{SYMPTOM_1}}"
|
||||
# - "{{SYMPTOM_2}}" # Add if applicable
|
||||
# - "{{SYMPTOM_3}}" # Add if applicable
|
||||
# - "{{SYMPTOM_4}}" # Add if applicable
|
||||
# - "{{SYMPTOM_5}}" # Add if applicable (max 5 per schema)
|
||||
root_cause: {{ROOT_CAUSE}}
|
||||
resolution_type: {{RESOLUTION_TYPE}}
|
||||
severity: {{SEVERITY}}
|
||||
# Optional fields (remove if not applicable)
|
||||
project: {{PROJECT|unknown}}
|
||||
language: {{LANGUAGE|unknown}}
|
||||
framework: {{FRAMEWORK|none}}
|
||||
tags:
|
||||
- {{TAG_1|untagged}}
|
||||
# - {{TAG_2}} # Add relevant tags for searchability
|
||||
# - {{TAG_3}} # Maximum 8 tags per schema
|
||||
related_issues: []
|
||||
---
|
||||
|
||||
# {{TITLE}}
|
||||
|
||||
## Problem
|
||||
|
||||
{{Brief description of the problem - what was happening, what was expected}}
|
||||
|
||||
### Symptoms
|
||||
|
||||
{{List the observable symptoms - error messages, visual issues, unexpected behavior}}
|
||||
|
||||
```
|
||||
{{Exact error message or log output if applicable}}
|
||||
```
|
||||
|
||||
### Context
|
||||
|
||||
- **Component:** {{COMPONENT}}
|
||||
- **Affected files:** {{List key files involved}}
|
||||
- **When it occurred:** {{Under what conditions - deployment, specific input, load, etc.}}
|
||||
|
||||
## Investigation
|
||||
|
||||
### What didn't work
|
||||
|
||||
1. {{First thing tried and why it didn't solve it}}
|
||||
2. {{Second thing tried and why it didn't solve it}}
|
||||
|
||||
### Root Cause
|
||||
|
||||
{{Technical explanation of the actual cause - be specific}}
|
||||
|
||||
## Solution
|
||||
|
||||
### The Fix
|
||||
|
||||
{{Describe what was changed and why}}
|
||||
|
||||
```{{LANGUAGE}}
|
||||
// Before
|
||||
{{Code that had the problem}}
|
||||
|
||||
// After
|
||||
{{Code with the fix}}
|
||||
```
|
||||
|
||||
### Files Changed
|
||||
|
||||
| File | Change |
|
||||
|------|--------|
|
||||
| {{file_path}} | {{Brief description of change}} |
|
||||
|
||||
## Prevention
|
||||
|
||||
### How to avoid this in the future
|
||||
|
||||
1. {{Preventive measure 1}}
|
||||
2. {{Preventive measure 2}}
|
||||
|
||||
### Warning signs to watch for
|
||||
|
||||
- {{Early indicator that this problem might be occurring}}
|
||||
|
||||
## Related
|
||||
|
||||
- {{Link to related solution docs or external resources}}
|
||||
Reference in New Issue
Block a user