|
1 | | -# Pull Request |
2 | | - |
3 | | -## 📋 Description |
4 | | -<!-- Provide a brief description of the changes in this PR --> |
5 | | - |
6 | | -### What does this PR do? |
7 | | -<!-- Describe the main purpose and functionality of this PR --> |
8 | | - |
9 | | -### Related Issue(s) |
10 | | -<!-- Link to related issues using #issue_number --> |
| 1 | +## Related Issues |
| 2 | +<!-- Link related issues --> |
11 | 3 | Fixes # |
12 | 4 | Closes # |
13 | | -Related to # |
14 | | - |
15 | | -## 🔧 Type of Change |
16 | | -<!-- Mark the relevant option with an [x] --> |
17 | | - |
18 | | -- [ ] 🐛 Bug fix (non-breaking change which fixes an issue) |
19 | | -- [ ] ✨ New feature (non-breaking change which adds functionality) |
20 | | -- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected) |
21 | | -- [ ] 📚 Documentation update |
22 | | -- [ ] 🎨 UI/UX improvement |
23 | | -- [ ] ⚡ Performance improvement |
24 | | -- [ ] 🔨 Refactoring (no functional changes) |
25 | | -- [ ] 🧪 Test addition or improvement |
26 | | -- [ ] 🔧 Configuration change |
27 | | -- [ ] 🚀 CI/CD improvement |
28 | 5 |
|
29 | | -## 🏗️ Architecture Impact |
30 | | -<!-- Mark the relevant components affected --> |
| 6 | +## Description |
| 7 | +<!-- Brief description of what this PR does --> |
31 | 8 |
|
32 | | -### Frontend (.NET MAUI) |
33 | | -- [ ] Views/Pages |
34 | | -- [ ] ViewModels |
35 | | -- [ ] Services |
36 | | -- [ ] Models |
37 | | -- [ ] Converters |
38 | | -- [ ] Styles/Resources |
39 | | -- [ ] Platform-specific code |
| 9 | +## Type of Change |
| 10 | +- [ ] Bug fix |
| 11 | +- [ ] New feature |
| 12 | +- [ ] Breaking change |
| 13 | +- [ ] Documentation update |
| 14 | +- [ ] Refactoring |
| 15 | +- [ ] Performance improvement |
40 | 16 |
|
41 | | -### Backend |
42 | | -- [ ] API Controllers |
43 | | -- [ ] Services |
44 | | -- [ ] Repositories |
45 | | -- [ ] Models/Entities |
46 | | -- [ ] Database migrations |
47 | | -- [ ] Authentication/Authorization |
48 | | -- [ ] Configuration |
49 | | - |
50 | | -### Shared/Core |
51 | | -- [ ] Shared models |
52 | | -- [ ] Interfaces |
53 | | -- [ ] Enums |
54 | | -- [ ] Extensions |
55 | | -- [ ] Utilities |
56 | | - |
57 | | -## 🧪 Testing |
58 | | -<!-- Describe the testing performed --> |
59 | | - |
60 | | -### Test Coverage |
| 17 | +## Testing |
61 | 18 | - [ ] Unit tests added/updated |
62 | | -- [ ] Integration tests added/updated |
63 | | -- [ ] UI tests added/updated |
64 | 19 | - [ ] Manual testing performed |
| 20 | +- [ ] All tests pass |
65 | 21 |
|
66 | | -### Testing Checklist |
67 | | -- [ ] All existing tests pass |
68 | | -- [ ] New functionality is covered by tests |
69 | | -- [ ] Edge cases are tested |
70 | | -- [ ] Error handling is tested |
71 | | - |
72 | | -### Manual Testing |
73 | | -<!-- Describe manual testing steps performed --> |
74 | | -1. |
75 | | -2. |
76 | | -3. |
77 | | - |
78 | | -## 📱 Platform Testing |
79 | | -<!-- Mark platforms where testing was performed --> |
80 | | - |
81 | | -- [ ] Android |
82 | | -- [ ] iOS |
83 | | -- [ ] Windows |
84 | | -- [ ] macOS |
85 | | - |
86 | | -## 🔍 Code Quality |
87 | | -<!-- Ensure code quality standards are met --> |
88 | | - |
89 | | -- [ ] Code follows project coding standards |
90 | | -- [ ] No compiler warnings introduced |
91 | | -- [ ] Code is properly documented |
92 | | -- [ ] Nullable reference types handled appropriately |
93 | | -- [ ] MVVM pattern followed (for frontend changes) |
94 | | -- [ ] Dependency injection used appropriately |
95 | | -- [ ] Error handling implemented |
96 | | -- [ ] Logging added where appropriate |
97 | | - |
98 | | -## 📊 Performance Impact |
99 | | -<!-- Describe any performance implications --> |
100 | | - |
101 | | -- [ ] No performance impact |
102 | | -- [ ] Performance improved |
103 | | -- [ ] Performance impact assessed and acceptable |
104 | | -- [ ] Performance testing performed |
105 | | - |
106 | | -### Performance Notes |
107 | | -<!-- Add details about performance changes if applicable --> |
108 | | - |
109 | | -## 🔒 Security Considerations |
110 | | -<!-- Mark if applicable --> |
111 | | - |
112 | | -- [ ] No security implications |
113 | | -- [ ] Security review required |
114 | | -- [ ] Authentication/Authorization changes |
115 | | -- [ ] Data validation added/updated |
116 | | -- [ ] Input sanitization implemented |
117 | | - |
118 | | -## 📸 Screenshots/Videos |
119 | | -<!-- Add screenshots or videos demonstrating the changes, especially for UI changes --> |
120 | | - |
121 | | -### Before |
122 | | -<!-- Screenshots of the current state --> |
123 | | - |
124 | | -### After |
125 | | -<!-- Screenshots of the new state --> |
126 | | - |
127 | | -## 📝 Migration Notes |
128 | | -<!-- If this PR requires database migrations or configuration changes --> |
129 | | - |
130 | | -### Database Changes |
131 | | -- [ ] No database changes |
132 | | -- [ ] Migration scripts included |
133 | | -- [ ] Backward compatible |
134 | | -- [ ] Data migration required |
135 | | - |
136 | | -### Configuration Changes |
137 | | -- [ ] No configuration changes |
138 | | -- [ ] New configuration keys added |
139 | | -- [ ] Environment variables updated |
140 | | -- [ ] Documentation updated |
141 | | - |
142 | | -## 📋 Checklist |
143 | | -<!-- Ensure all items are completed before requesting review --> |
144 | | - |
145 | | -### General |
146 | | -- [ ] PR title is descriptive and follows conventional commit format |
147 | | -- [ ] Code is self-documenting or includes necessary comments |
148 | | -- [ ] No debugging code left in the codebase |
149 | | -- [ ] No hardcoded values (use configuration instead) |
150 | | -- [ ] Error messages are user-friendly |
151 | | -- [ ] Logging is appropriate and not excessive |
152 | | - |
153 | | -### Frontend Specific |
154 | | -- [ ] UI is responsive across different screen sizes |
155 | | -- [ ] Accessibility considerations addressed |
156 | | -- [ ] Loading states implemented where appropriate |
157 | | -- [ ] Error states handled gracefully |
158 | | -- [ ] Navigation flows work correctly |
159 | | -- [ ] Data binding is properly implemented |
160 | | -- [ ] Memory leaks avoided (event handlers unsubscribed) |
161 | | - |
162 | | -### Backend Specific |
163 | | -- [ ] API endpoints follow RESTful conventions |
164 | | -- [ ] Input validation implemented |
165 | | -- [ ] Proper HTTP status codes returned |
166 | | -- [ ] API documentation updated (if applicable) |
167 | | -- [ ] Database queries are optimized |
168 | | -- [ ] Proper exception handling implemented |
169 | | - |
170 | | -## 🔄 Deployment Notes |
171 | | -<!-- Any special deployment considerations --> |
172 | | - |
173 | | -- [ ] No special deployment steps required |
174 | | -- [ ] Requires database migration |
175 | | -- [ ] Requires configuration updates |
176 | | -- [ ] Requires cache clearing |
177 | | -- [ ] Requires service restart |
178 | | - |
179 | | -### Deployment Steps |
180 | | -<!-- List any special deployment steps if applicable --> |
181 | | -1. |
182 | | -2. |
183 | | -3. |
184 | | - |
185 | | -## 👥 Reviewers |
186 | | -<!-- Tag specific reviewers if needed --> |
187 | | - |
188 | | -### Required Reviews |
189 | | -- [ ] Code review |
190 | | -- [ ] UI/UX review (for frontend changes) |
191 | | -- [ ] Security review (for security-related changes) |
192 | | -- [ ] Performance review (for performance-critical changes) |
193 | | - |
194 | | -### Suggested Reviewers |
195 | | -<!-- @mention specific team members --> |
196 | | - |
197 | | -## 📚 Additional Notes |
198 | | -<!-- Any additional information that reviewers should know --> |
199 | | - |
200 | | -### Breaking Changes |
201 | | -<!-- Describe any breaking changes and migration path --> |
202 | | - |
203 | | -### Future Considerations |
204 | | -<!-- Any follow-up work or considerations for future PRs --> |
205 | | - |
206 | | ---- |
| 22 | +### Test Steps |
| 23 | +- |
207 | 24 |
|
208 | | -## 📋 Review Checklist (for Reviewers) |
209 | | -<!-- Checklist for reviewers --> |
| 25 | +## Screenshots |
| 26 | +<!-- Add screenshots for UI changes --> |
210 | 27 |
|
211 | | -- [ ] Code logic is sound and efficient |
212 | | -- [ ] Code follows project conventions and standards |
213 | | -- [ ] Tests are comprehensive and pass |
214 | | -- [ ] Documentation is adequate |
215 | | -- [ ] Security considerations are addressed |
216 | | -- [ ] Performance impact is acceptable |
217 | | -- [ ] UI/UX changes are intuitive and accessible |
218 | | -- [ ] Error handling is robust |
219 | | -- [ ] No obvious bugs or edge cases missed |
| 28 | +## Checklist |
| 29 | +- [ ] Code follows project standards |
| 30 | +- [ ] Self-reviewed the code |
| 31 | +- [ ] Added/updated documentation |
| 32 | +- [ ] No breaking changes (or documented) |
| 33 | +- [ ] Tested on relevant platforms |
0 commit comments