|
| 1 | +## Description |
| 2 | +<!-- Provide a brief description of the changes in this PR --> |
| 3 | + |
| 4 | +## Type of Change |
| 5 | +<!-- Mark the relevant option with an 'x' --> |
| 6 | + |
| 7 | +- [ ] Bug fix (non-braking change that fixes an issue) |
| 8 | +- [ ] New feature (non-breaking change that adds functionality) |
| 9 | +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 10 | +- [ ] Documentation update |
| 11 | +- [ ] Code refactoring |
| 12 | +- [ ] Performance improvement |
| 13 | +- [ ] Test addition or update |
| 14 | +- [ ] Build/CI update |
| 15 | + |
| 16 | +## Related Issues |
| 17 | +<!-- Link to related issues using #issue_number --> |
| 18 | + |
| 19 | +Closes # |
| 20 | + |
| 21 | +## Changes Made |
| 22 | +<!-- List the main changes made in this PR --> |
| 23 | + |
| 24 | +- |
| 25 | +- |
| 26 | +- |
| 27 | + |
| 28 | +## Screenshots/Videos |
| 29 | +<!-- If applicable, add screenshots or videos demonstrating the changes --> |
| 30 | + |
| 31 | +### Before |
| 32 | +<!-- Screenshot of before changes --> |
| 33 | + |
| 34 | +### After |
| 35 | +<!-- Screenshot of after the changes --> |
| 36 | + |
| 37 | +## Testing |
| 38 | +<!-- Describe the tests you ran and how to reproduce them --> |
| 39 | + |
| 40 | +### Test Configuration |
| 41 | +- **OS:** |
| 42 | +- **Browser:** |
| 43 | +- **Node version:** |
| 44 | + |
| 45 | +### Test Steps |
| 46 | +1. |
| 47 | +2. |
| 48 | +3. |
| 49 | + |
| 50 | +## Checklist |
| 51 | +<!-- Mark completed items with an 'x' --> |
| 52 | + |
| 53 | +### Code Quality |
| 54 | +- [ ] My code follows the project's style guidelines |
| 55 | +- [ ] I have performed a self-review of my code |
| 56 | +- [ ] I have commented my code, particulary in hard-to-understand areas |
| 57 | +- [ ] I have made corresponding changes to the documentation |
| 58 | +- [ ] My changes generate no new warnings |
| 59 | +- [ ] I have added tests that prove my fix is effective or that my feature works |
| 60 | +- [ ] New and existing unit tests pass locally with my changes |
| 61 | + |
| 62 | +### Testing |
| 63 | +- [ ] I have tested on desktop |
| 64 | +- [ ] I have tested on mobile |
| 65 | +- [ ] I have tested on tablet |
| 66 | +- [ ] I have tested on multiple browseers (Chrome, Firefox, Safari) |
| 67 | +- [ ] All tests pass: `npm test` |
| 68 | +- [ ] TypeScript compiles: `npm run typecheck` |
| 69 | +- [ ] Linting passes: `npm run lit` |
| 70 | + |
| 71 | +### Accessibility |
| 72 | +- [ ] I have tested with a screen reader |
| 73 | +- [ ] All images have alt text |
| 74 | +- [ ] Color contrast meets WCAG AA standards |
| 75 | +- [ ] Keyboard navigation works |
| 76 | +- [ ] Focus indicators are visible |
| 77 | + |
| 78 | +### Responsive Design |
| 79 | +- [ ] Works on mobile (375px width) |
| 80 | +- [ ] Works on tablet (768px width) |
| 81 | +- [ ] Works on desktop (1440px width) |
| 82 | +- [ ] No horizontal scrolling on mobile |
| 83 | + |
| 84 | +### Performance |
| 85 | +- [ ] Images are optimized |
| 86 | +- [ ] No unnecessary re-renders |
| 87 | +- [ ] Bundle size impact is reasonable |
| 88 | +- [ ] Page load time is acceptable |
| 89 | + |
| 90 | +### Security |
| 91 | +- [ ] No sensitive data in code |
| 92 | +- [ ] API keys are in environment variables |
| 93 | +- [ ] Input validation is implemented |
| 94 | +- [ ] SQL injection prevention is in place (if applicable) |
| 95 | +- [ ] XSS prevention is in place |
| 96 | + |
| 97 | +### Documentation |
| 98 | +- [ ] README updated (if needed) |
| 99 | +- [ ] API documentation updated (if needed) |
| 100 | +- [ ] Component props documented (if new component) |
| 101 | +- [ ] CHANGELOG updated (if applicable) |
| 102 | + |
| 103 | +## Additional Notes |
| 104 | +<!-- Add any additional notes for reviewers --> |
| 105 | + |
| 106 | +## For Reviewers |
| 107 | +<!-- What should reviewers focus on? --> |
| 108 | + |
| 109 | +**Focus areas:** |
| 110 | +- |
| 111 | +- |
| 112 | + |
| 113 | +**Questions:** |
| 114 | +- |
| 115 | +- |
| 116 | + |
| 117 | +--- |
| 118 | + |
| 119 | +**Checklist for Reviewers** |
| 120 | +- [ ] Code follows project conventions |
| 121 | +- [ ] Changes are well-tested |
| 122 | +- [ ] Documentation is clear and complete |
| 123 | +- [ ] No obvious security issues |
| 124 | +- [ ] Performance impact is acceptable |
0 commit comments