Issue Templates

Bug Report Template

### Bug Description
<!-- Clear description of the bug -->

### Steps to Reproduce
1.
2.
3.

### Expected Behavior
<!-- What should happen -->

### Actual Behavior
<!-- What actually happens -->

### Environment
- OS: <!-- Windows / Linux / macOS + version -->
- Compiler: <!-- MSVC / GCC / Clang + version -->
- Audio-lab version/commit: <!-- tag or commit hash -->
- Sample Rate: <!-- if applicable -->
- Buffer Size: <!-- if applicable -->

### Audio Symptoms (if applicable)
- [ ] Clicks/pops
- [ ] Distortion
- [ ] Silence
- [ ] Incorrect output
- [ ] Performance issue
- [ ] Other:

### Logs/Stack Trace
<!-- Paste relevant logs, stack traces, or error messages -->

Additional Context

Severity

• Critical (crash, data loss)
• High (incorrect output, major feature broken)
• Medium (edge case, workaround exists)
• Low (cosmetic, minor)

  ---
  
  ## Feature Request Template
  
  ```markdown
  ### Feature Description
  <!-- What feature do you want? -->
  
  ### Use Case
  <!-- Why do you need this? What problem does it solve? -->
  
  ### Proposed API/Interface
  <!-- How should it work? Code examples welcome -->
  ```cpp
  // Example usage
  auto filter = StateVariableFilter(sampleRate);
  filter.setCutoff(1000.0f);
  filter.process(audioBuffer);
  

Alternative Solutions

RT Safety Requirements

• Must be RT-safe (audio thread)
• Can allocate (UI/setup only)
• Not sure

Implementation Complexity

• Small (< 1 day)
• Medium (1-3 days)
• Large (> 3 days)
• Not sure

Related Features

Additional Context

---

## Performance Issue Template

```markdown
### Performance Problem
<!-- What's slow? -->

### Current Performance
<!-- Metrics, timings, profile data -->

Function: process() Time: 250µs per buffer CPU: 25% on single core

### Expected Performance
<!-- How fast should it be? -->

### Profiling Results
<!-- Attach profiler screenshots or flamegraphs -->

### Environment
- OS:
- CPU:
- Compiler:
- Optimization flags:

### Code Location
<!-- File:line where bottleneck is -->

### Proposed Solution
<!-- Ideas for optimization -->
- [ ] Use SIMD
- [ ] Better algorithm
- [ ] Cache optimization
- [ ] Reduce allocations
- [ ] Other:

### Benchmarks
<!-- Any benchmark code or results -->

---

Documentation Issue Template

### Documentation Problem
<!-- What's unclear or missing? -->

### Location
<!-- Link to docs or file:line -->

### Current State
<!-- What does it say now? -->

### Suggested Improvement
<!-- How should it change? -->

### Related Code
<!-- Links to implementation if relevant -->

---

Refactoring Proposal Template

### Current State
<!-- What code needs refactoring? -->
File:
Lines:

### Problems with Current Code
- [ ] Hard to understand
- [ ] Hard to maintain
- [ ] Hard to test
- [ ] Performance issues
- [ ] Code duplication
- [ ] Other:

### Proposed Refactoring
<!-- How should it be restructured? -->

### Benefits
-
-

### Risks
-
-

### Breaking Changes
<!-- Will this break existing code? -->
- [ ] Yes
- [ ] No

### Migration Path
<!-- If breaking, how do users migrate? -->

### Related Issues
<!-- Links to related bugs or features -->

---

Usage Notes

Creating GitHub Issue Templates

Place these in .github/ISSUE_TEMPLATE/:

.github/
└── ISSUE_TEMPLATE/
    ├── bug_report.md
    ├── feature_request.md
    ├── performance_issue.md
    └── documentation.md

Each file should have frontmatter:

---
name: Bug Report
about: Report a bug or incorrect behavior
title: '[BUG] '
labels: bug
assignees: ''
---

Template Selection

GitHub will show template chooser when creating issues.

Custom Fields

Add project-specific fields as needed: - Module affected - Priority - Sprint/Milestone - Estimated effort