~linuxgoose/engineering-templates

0aefbfbd78222083e857a81e376cd35bc66c8868 — Jordan Robinson 3 months ago 93c8a46
add bug fix template
2 files changed, 99 insertions(+), 0 deletions(-)

M README.md
A templates/bug-fix.md
M README.md => README.md +1 -0
@@ 5,3 5,4 @@ Comprehensive collection of templates for solutions design, architecture decisio
## Templates

* Feature Request
* Bug Fix
\ No newline at end of file

A templates/bug-fix.md => templates/bug-fix.md +98 -0
@@ 0,0 1,98 @@
# Template 2: Bug Fix - Solution Design

## Overview
**Bug ID:** [Ticket number]  
**Title:** [Bug description]  
**Severity:** [Critical/High/Medium/Low]  
**Environment:** [Production/Staging/Development]  
**Status:** [Draft/Review/Approved/In Progress]  
**Created:** [Date]  

## Issue Description
Clear explanation of what is broken and how it manifests. Include:
- Steps to reproduce
- Current behavior vs. expected behavior
- Affected users/systems
- Business impact

## Root Cause Analysis
Detailed investigation and explanation of why this bug exists. Include:
- What triggered the investigation
- Findings and evidence
- Technical details of the root cause
- When this was introduced (if known)

## Proposed Solution

### Fix Approach
Technical description of how the bug will be fixed. Include:
- Changes to code, data, or architecture
- Why this approach solves the root cause
- Any side effects or considerations

### Affected Components
List all files, functions, modules, or services that will be modified:
- Component/file name
- Type of change (new/modified/deprecated)
- Brief description of change

### Code Changes
Pseudocode or outline of key changes:

```
[Pseudocode or high-level logic]
```

## Data Impact
- Will existing data need to be migrated or cleaned?
- Data validation or integrity checks needed?
- Rollback data requirements

## Testing Strategy
- Specific test cases to verify the fix
- Regression test coverage
- Testing in different environments
- Performance impact verification

## Deployment Plan

### Pre-deployment
- Backups needed
- Data migration (if applicable)
- Configuration changes
- Notifications to stakeholders

### Deployment
- Deployment strategy
- Deployment window/timing
- Rollback procedure and triggers

### Post-deployment
- Monitoring checklist
- Verification steps
- User communication

## Performance Impact
- Expected performance change (positive/negative/neutral)
- Benchmarks before/after
- Scalability implications

## Risk Assessment

| Risk | Likelihood | Impact | Mitigation |
|------|-----------|--------|-----------|
| [Risk 1] | [High/Medium/Low] | [High/Medium/Low] | [Plan] |
| [Risk 2] | [High/Medium/Low] | [High/Medium/Low] | [Plan] |

## Alternatives Considered
Other approaches evaluated and why this solution was selected.

## Approval & Sign-off
| Role | Name | Date |
|------|------|------|
| Lead Developer | | |
| Tech Lead | | |
| QA Lead | | |

## Implementation Notes
Any additional context, decisions, or considerations for the developer(s) implementing this fix.
\ No newline at end of file