|
1 | 1 | ## Summary |
2 | | -Briefly describe the changes. Link related issues (e.g., Closes #123). |
| 2 | +<!-- Briefly describe what this PR does and why --> |
3 | 3 |
|
4 | | -## Type of change |
5 | | -- [ ] Bug fix |
6 | | -- [ ] New feature |
7 | | -- [ ] Refactor/Chore |
8 | | -- [ ] Documentation |
| 4 | +**What**: Brief description of the changes |
| 5 | +**Why**: The problem this solves or feature this adds |
| 6 | +**Linked Issues**: Closes #[issue_number] | Fixes #[issue_number] | Related to #[issue_number] |
| 7 | + |
| 8 | +## Type of Change |
| 9 | +- [ ] Bug fix (non-breaking change which fixes an issue) |
| 10 | +- [ ] New feature (non-breaking change which adds functionality) |
| 11 | +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
| 12 | +- [ ] Refactor (code change that neither fixes a bug nor adds a feature) |
| 13 | +- [ ] Documentation (changes to README, guides, comments) |
| 14 | +- [ ] Tests (adding missing tests or correcting existing tests) |
| 15 | +- [ ] Performance improvement |
9 | 16 |
|
10 | 17 | ## Screenshots (if UI changes) |
| 18 | +<!-- Include before/after screenshots for UI changes --> |
| 19 | + |
| 20 | +| Before | After | |
| 21 | +|--------|-------| |
| 22 | +| Screenshot | Screenshot | |
| 23 | + |
| 24 | +## Testing Instructions |
| 25 | +### For Reviewers: |
| 26 | +1. **Backend Setup** (if applicable): |
| 27 | + ```bash |
| 28 | + cd backend |
| 29 | + npm install |
| 30 | + npm run dev |
| 31 | + ``` |
11 | 32 |
|
12 | | -## How to test |
13 | | -- Steps to verify the change locally |
14 | | -- Any API endpoints impacted |
| 33 | +2. **Extension Setup** (if applicable): |
| 34 | + - Open `chrome://extensions` |
| 35 | + - Enable Developer Mode |
| 36 | + - Load unpacked extension from `/extension` folder |
| 37 | + |
| 38 | +3. **Test Steps**: |
| 39 | + - [ ] Step 1: ... |
| 40 | + - [ ] Step 2: ... |
| 41 | + - [ ] Step 3: ... |
| 42 | + |
| 43 | +### Tested Environments: |
| 44 | +- [ ] Chrome (Version: ___) |
| 45 | +- [ ] Windows/Mac/Linux |
| 46 | +- [ ] Backend API (if applicable) |
15 | 47 |
|
16 | 48 | ## Checklist |
17 | | -- [ ] I read the CONTRIBUTING.md and followed the guidelines |
18 | | -- [ ] I ran the backend locally for API changes (`npm run dev` in `backend/`) |
19 | | -- [ ] I tested the extension locally (Load Unpacked) for UI changes |
20 | | -- [ ] I added/updated documentation where needed |
21 | | -- [ ] I added labels (e.g., `hacktoberfest`, `good first issue`) if applicable |
22 | | - |
23 | | -## Hacktoberfest |
24 | | -If this is for Hacktoberfest, maintainers can mark this PR as: |
25 | | -- merge, or |
26 | | -- approve the review, or |
27 | | -- add the `hacktoberfest-accepted` label |
| 49 | +### General |
| 50 | +- [ ] I read and followed [CONTRIBUTING.md](../CONTRIBUTING.md) |
| 51 | +- [ ] I tested my changes thoroughly |
| 52 | +- [ ] I updated documentation where needed |
| 53 | + |
| 54 | +### Code Quality |
| 55 | +- [ ] Code follows existing style conventions |
| 56 | +- [ ] Added comments for complex logic |
| 57 | +- [ ] No commented-out code left behind |
| 58 | +- [ ] No unnecessary dependencies added |
| 59 | + |
| 60 | +### Functionality |
| 61 | +- [ ] Changes work as expected |
| 62 | +- [ ] No existing functionality is broken |
| 63 | +- [ ] Error handling is appropriate |
| 64 | +- [ ] Performance impact considered |
| 65 | + |
| 66 | +### Project Specific |
| 67 | +- [ ] Extension loads without errors (if applicable) |
| 68 | +- [ ] Backend API works correctly (if applicable) |
| 69 | +- [ ] UI follows existing theme system (if applicable) |
| 70 | + |
| 71 | +## Additional Notes |
| 72 | +<!-- Any additional context, concerns, or notes for reviewers --> |
| 73 | + |
| 74 | +**Questions for Reviewers**: |
| 75 | +- Any specific areas you'd like extra attention on? |
| 76 | + |
| 77 | +**Breaking Changes**: [List any breaking changes and migration steps] |
| 78 | + |
| 79 | +**Future Work**: [Any follow-up work needed?] |
0 commit comments