|
1 |
| -# Description |
| 1 | +# 📋 Pull Request |
2 | 2 |
|
3 |
| -Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. |
| 3 | +## 📝 Description |
4 | 4 |
|
5 |
| -Fixes # (issue) |
| 5 | +**Summary:** Provide a clear and concise description of what this PR does. |
6 | 6 |
|
7 |
| -## Type of change |
| 7 | +**Context:** Explain the motivation behind these changes and any relevant background information. |
8 | 8 |
|
9 |
| -Please delete options that are not relevant. |
| 9 | +**Related Issues:** |
| 10 | +- Closes #(issue) |
| 11 | +- Addresses #(issue) |
| 12 | +- Related to #(issue) |
10 | 13 |
|
11 |
| -- [ ] Bug fix (non-breaking change which fixes an issue) |
12 |
| -- [ ] New feature (non-breaking change which adds functionality) |
13 |
| -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
14 |
| -- [ ] This change requires a documentation update |
| 14 | +--- |
15 | 15 |
|
16 |
| -# How Has This Been Tested? |
| 16 | +## 🔄 Type of Change |
17 | 17 |
|
18 |
| -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration |
| 18 | +<!-- Please check the type of change your PR introduces --> |
19 | 19 |
|
20 |
| -- [ ] Test A |
21 |
| -- [ ] Test B |
| 20 | +- [ ] 🐛 **Bug fix** - non-breaking change which fixes an issue |
| 21 | +- [ ] ✨ **New feature** - non-breaking change which adds functionality |
| 22 | +- [ ] 💥 **Breaking change** - fix or feature that would cause existing functionality to not work as expected |
| 23 | +- [ ] 📚 **Documentation** - updates to documentation only |
| 24 | +- [ ] 🎨 **Style** - formatting, missing semi colons, etc; no code change |
| 25 | +- [ ] ♻️ **Refactor** - code change that neither fixes a bug nor adds a feature |
| 26 | +- [ ] ⚡ **Performance** - code change that improves performance |
| 27 | +- [ ] ✅ **Test** - adding missing tests or correcting existing tests |
| 28 | +- [ ] 🔧 **Build** - changes that affect the build system or external dependencies |
| 29 | +- [ ] 👷 **CI** - changes to CI configuration files and scripts |
| 30 | +- [ ] 🚀 **Deploy** - changes related to deployment |
22 | 31 |
|
23 |
| -# Checklist: |
| 32 | +--- |
24 | 33 |
|
25 |
| -- [ ] My code follows the style guidelines of this project |
26 |
| -- [ ] I have performed a self-review of my code |
27 |
| -- [ ] I have commented my code, particularly in hard-to-understand areas |
28 |
| -- [ ] I have made corresponding changes to the documentation |
29 |
| -- [ ] My changes generate no new warnings |
30 |
| -- [ ] I have added tests that prove my fix is effective or that my feature works |
31 |
| -- [ ] New and existing unit tests pass locally with my changes |
32 |
| -- [ ] Any dependent changes have been merged and published in downstream modules |
| 34 | +## 🧪 Testing |
| 35 | + |
| 36 | +### Test Coverage |
| 37 | +- [ ] Unit tests added/updated |
| 38 | +- [ ] Integration tests added/updated |
| 39 | +- [ ] E2E tests added/updated |
| 40 | +- [ ] Manual testing completed |
| 41 | + |
| 42 | +### Test Instructions |
| 43 | +<!-- Provide step-by-step instructions to test your changes --> |
| 44 | + |
| 45 | +1. **Setup:** |
| 46 | + ```bash |
| 47 | + npm install |
| 48 | + npm run build |
| 49 | + ``` |
| 50 | + |
| 51 | +2. **Test scenarios:** |
| 52 | + - [ ] Scenario A: _describe test case_ |
| 53 | + - [ ] Scenario B: _describe test case_ |
| 54 | + - [ ] Edge cases: _describe edge cases tested_ |
| 55 | + |
| 56 | +3. **Verification:** |
| 57 | + ```bash |
| 58 | + npm run test |
| 59 | + npm run lint |
| 60 | + npm run type-check |
| 61 | + ``` |
| 62 | + |
| 63 | +### Test Results |
| 64 | +<!-- Include test output, screenshots, or GIFs demonstrating the changes --> |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +## 📸 Screenshots/Demo |
| 69 | + |
| 70 | +<!-- If applicable, add screenshots, GIFs, or links to demonstrate visual changes --> |
| 71 | + |
| 72 | +| Before | After | |
| 73 | +|--------|-------| |
| 74 | +| _screenshot/description_ | _screenshot/description_ | |
| 75 | + |
| 76 | +--- |
| 77 | + |
| 78 | +## 📚 Documentation |
| 79 | + |
| 80 | +- [ ] Code is self-documenting with clear variable/function names |
| 81 | +- [ ] Added/updated JSDoc comments for public APIs |
| 82 | +- [ ] Updated README.md if needed |
| 83 | +- [ ] Updated CHANGELOG.md |
| 84 | +- [ ] Added/updated component documentation |
| 85 | +- [ ] Updated TypeScript type definitions |
| 86 | + |
| 87 | +--- |
| 88 | + |
| 89 | +## 🔍 Code Quality Checklist |
| 90 | + |
| 91 | +### Code Standards |
| 92 | +- [ ] Code follows project's style guidelines (ESLint/Prettier) |
| 93 | +- [ ] Code follows TypeScript best practices |
| 94 | +- [ ] No `console.log` statements in production code |
| 95 | +- [ ] No TODO/FIXME comments without corresponding issues |
| 96 | +- [ ] Proper error handling implemented |
| 97 | +- [ ] Security considerations addressed |
| 98 | + |
| 99 | +### Performance & Accessibility |
| 100 | +- [ ] Performance impact considered and optimized |
| 101 | +- [ ] Accessibility guidelines followed (WCAG 2.1) |
| 102 | +- [ ] Mobile responsiveness tested |
| 103 | +- [ ] Browser compatibility verified |
| 104 | + |
| 105 | +### Review & Testing |
| 106 | +- [ ] Self-review completed |
| 107 | +- [ ] Code is well-commented and self-explanatory |
| 108 | +- [ ] All existing tests pass |
| 109 | +- [ ] New tests added for new functionality |
| 110 | +- [ ] Manual testing completed |
| 111 | +- [ ] No new warnings or errors introduced |
| 112 | + |
| 113 | +--- |
| 114 | + |
| 115 | +## 🚀 Deployment Considerations |
| 116 | + |
| 117 | +- [ ] No database migrations required |
| 118 | +- [ ] No environment variable changes required |
| 119 | +- [ ] Backward compatible with previous version |
| 120 | +- [ ] Safe to deploy to production |
| 121 | +- [ ] Feature flags implemented if needed |
| 122 | + |
| 123 | +--- |
| 124 | + |
| 125 | +## 📦 Dependencies |
| 126 | + |
| 127 | +<!-- List any new dependencies added or updated --> |
| 128 | + |
| 129 | +### Added |
| 130 | +- `package-name@version` - _reason for addition_ |
| 131 | + |
| 132 | +### Updated |
| 133 | +- `package-name@old-version` → `package-name@new-version` - _reason for update_ |
| 134 | + |
| 135 | +### Removed |
| 136 | +- `package-name@version` - _reason for removal_ |
| 137 | + |
| 138 | +--- |
| 139 | + |
| 140 | +## 🔗 Additional Information |
| 141 | + |
| 142 | +### Related PRs |
| 143 | +<!-- Link to any related PRs in this or other repositories --> |
| 144 | + |
| 145 | +### Breaking Changes |
| 146 | +<!-- If this is a breaking change, provide migration guide --> |
| 147 | + |
| 148 | +### Notes for Reviewers |
| 149 | +<!-- Any specific areas you'd like reviewers to focus on --> |
| 150 | + |
| 151 | +--- |
| 152 | + |
| 153 | +## 📋 Reviewer Checklist |
| 154 | + |
| 155 | +<!-- For reviewers to complete --> |
| 156 | + |
| 157 | +- [ ] Code review completed |
| 158 | +- [ ] Tests reviewed and adequate |
| 159 | +- [ ] Documentation reviewed |
| 160 | +- [ ] Breaking changes identified and documented |
| 161 | +- [ ] Security implications considered |
| 162 | +- [ ] Performance impact assessed |
0 commit comments