Pr Prep

# Pull Request Template Structure

## Standard Template Sections

### 1. Summary (Required)
Brief 1-2 sentence description of what the PR accomplishes and why.

**Good Examples:**
```markdown
## Summary
Add support for modular skills to reduce token usage and improve skill maintainability through progressive loading.
```

```markdown
## Summary
Fix authentication bug causing session timeout errors by implementing proper token refresh logic.
```

**Avoid:**
- Implementation details (save for Changes section)
- Vague descriptions like "various improvements"
- AI/tool attribution

### 2. Changes (Required)
Bullet list of specific changes grouped logically, explaining both what and why.

**Structure:**
```markdown
## Changes
- **Category 1**: What changed and why
  - Sub-detail if needed
- **Category 2**: What changed and why
- **Breaking changes**: Highlight any breaking changes first
```

**Good Examples:**
```markdown
## Changes
- **API**: Add `read_yaml()` and `to_pdf()` functions for symmetric I/O pattern
- **Session Management**: Introduce `ResumeSession` class to centralize configuration
- **Documentation**: Update README with new API examples and migration guide
- **Breaking**: Remove deprecated `generate_pdf()` function (use `to_pdf()` instead)
```

### 3. Testing (Required)
List each validation step taken, with commands and results.

**Format:**
```markdown
## Testing
- `make test` - all 47 tests passing
- `make lint` - no warnings
- `pytest --cov` - 94% coverage (up from 89%)
- Manual verification: Tested PDF generation with 3 resume templates
- CI will run: cross-platform tests, integration tests
```

**Include:**
- Exact commands run
- Pass/fail status and counts
- Coverage changes if significant
- Manual testing performed
- What will run in CI (if different from local)

### 4. Checklist (Required)
Standard quality checklist for all PRs.

**Template:**
```markdown
## Checklist
- [ ] Code follows project style guidelines
- [ ] Tests pass locally
- [ ] Documentation updated if needed
- [ ] Breaking changes documented (if applicable)
```

**Extended Checklist (for complex PRs):**
```markdown
## Checklist
- [ ] Code follows project style guidelines
- [ ] Tests pass locally
- [ ] Tests added/updated for new functionality
- [ ] Documentation updated if needed
- [ ] Breaking changes documented (if applicable)
- [ ] Migration guide provided (if needed)
- [ ] Backward compatibility maintained (or breaking change justified)
- [ ] Performance impact assessed
- [ ] Security implications reviewed
```

## Optional Sections

### Screenshots/Visual Changes
For UI, CLI output, or visual changes:
```markdown
## Screenshots
**Before:**
[screenshot or command output]

**After:**
[screenshot or command output]
```

### Follow-up TODOs
For work deferred to future PRs:
```markdown
## Follow-up Work
- [ ] Add integration tests for edge cases (Issue #123)
- [ ] Update deployment documentation
- [ ] Performance optimization for large files
```

### Issue References
Link related issues:
```markdown
Fixes #456
Related to #789
Part of #101
```

### Migration Guide
For breaking changes:
```markdown
## Migration Guide
**Before:**
\`\`\`python
generate_pdf(resume, "output.pdf")
\`\`\`

**After:**
\`\`\`python
resume.to_pdf("output.pdf")
\`\`\`
```

### Performance Impact
For performance-related changes:
```markdown
## Performance Impact
- PDF generation: 2.3s → 0.8s (65% improvement)
- Memory usage: 150MB → 45MB
- Benchmark results: [link to benchmark output]
```

### Security Considerations
For security-related changes:
```markdown
## Security Considerations
- Input validation added for all user-supplied paths
- Sanitization applied to template variables
- No secrets or credentials in code or tests
```

## Best Practices for PR Descriptions

### Do's
- Be concise but complete
- Focus on "why" not just "what"
- Use bullet points for scannability
- Include actual commands and results
- Link to relevant issues
- Highlight breaking changes prominently