|
1 | 1 | --- |
2 | 2 | name: Pull Request |
3 | | -about: Submit changes to the project for review and inclusion |
| 3 | +about: Submit changes to the Sugar Labs website for review |
4 | 4 | --- |
5 | 5 |
|
6 | | -## Description |
| 6 | +## π Description |
7 | 7 |
|
8 | | -<!--- Describe the changes introduced by this pull request. --> |
9 | | -<!--- Explain what problem it solves or what feature/fix it adds. --> |
| 8 | +<!--- Provide a clear and concise description of your changes. --> |
| 9 | +<!--- Explain what problem it solves or what feature/improvement it adds. --> |
10 | 10 |
|
11 | | -## Related Issue |
12 | 11 |
|
13 | | -<!--- If this pull request is related to a specific issue, reference it here using #issue_number. --> |
14 | | -<!--- For example, "Fixes #123" or "Addresses #456". --> |
| 12 | +## π Related Issue |
15 | 13 |
|
16 | | -This PR fixes # |
| 14 | +<!--- If this PR is related to any issue(s), link them here using #issue_number --> |
| 15 | +<!--- For example: "Fixes #123" or "Part of #456" --> |
17 | 16 |
|
18 | | -## Changes Made |
| 17 | +Fixes # |
19 | 18 |
|
20 | | -<!--- Provide a summary of the changes made in this pull request. --> |
21 | | -<!--- Include any relevant technical details or architecture changes. --> |
| 19 | +## π Type of Change |
22 | 20 |
|
23 | | -- Change 1 |
24 | | -- Change 2 |
25 | | -- ... |
| 21 | +<!--- What types of changes does your code introduce? Put an `x` in all boxes that apply: --> |
26 | 22 |
|
27 | | -## Testing Performed |
| 23 | +- [ ] π± New Feature (new page, component, or functionality) |
| 24 | +- [ ] π¨ UI/UX Update (visual changes, styling improvements) |
| 25 | +- [ ] π Content Update (text changes, documentation) |
| 26 | +- [ ] π Bug Fix |
| 27 | +- [ ] β‘ Performance Improvement |
| 28 | +- [ ] βΏ Accessibility Enhancement |
| 29 | +- [ ] π Security Update |
| 30 | +- [ ] π¦ Dependency Update |
| 31 | +- [ ] π§Ή Code Refactoring |
| 32 | +- [ ] π§ͺ Test Updates |
28 | 33 |
|
29 | | -<!--- Describe the testing that you have performed to validate these changes. --> |
30 | | -<!--- Include information about test cases, testing environments, and results. --> |
| 34 | +## π· Visual Changes |
31 | 35 |
|
32 | | -- Tested feature X in scenario Y. |
33 | | -- Ran unit tests for component Z. |
34 | | -- Tested on browsers A, B, and C. |
35 | | -- ... |
| 36 | +<!--- If your changes affect the website's appearance, please provide screenshots --> |
| 37 | +<!--- For UI changes, include before/after screenshots if possible --> |
36 | 38 |
|
37 | | -## Checklist |
| 39 | +<details> |
| 40 | +<summary>Screenshots / GIFs</summary> |
38 | 41 |
|
39 | | -<!--- Please check the boxes that apply to this pull request. --> |
40 | | -<!--- You can add or remove items as needed. --> |
| 42 | +<!-- Drag and drop your screenshots here --> |
41 | 43 |
|
42 | | -- [ ] I have tested these changes locally and they work as expected. |
43 | | -- [ ] I have added/updated tests that prove the effectiveness of these changes. |
44 | | -- [ ] I have updated the documentation to reflect these changes, if applicable. |
45 | | -- [ ] I have followed the project's coding style guidelines. |
46 | | -- [ ] I have addressed the code review feedback from the previous submission, if applicable. |
| 44 | +</details> |
47 | 45 |
|
48 | | -## Additional Notes for Reviewers |
| 46 | +## π§ͺ Testing Performed |
| 47 | + |
| 48 | +### π± Browser Compatibility |
| 49 | + |
| 50 | +<!--- Check all browsers where you've tested these changes --> |
| 51 | + |
| 52 | +- [ ] Chrome (Version: ) |
| 53 | +- [ ] Firefox (Version: ) |
| 54 | +- [ ] Safari (Version: ) |
| 55 | +- [ ] Edge (Version: ) |
| 56 | +- [ ] Mobile Chrome (Device: ) |
| 57 | +- [ ] Mobile Safari (Device: ) |
| 58 | + |
| 59 | +### π₯οΈ Responsive Design |
| 60 | + |
| 61 | +<!--- Confirm testing on different screen sizes --> |
| 62 | + |
| 63 | +- [ ] Desktop (1200px+) |
| 64 | +- [ ] Tablet (768px - 1199px) |
| 65 | +- [ ] Mobile (320px - 767px) |
| 66 | + |
| 67 | +### β
Test Cases |
| 68 | + |
| 69 | +<!--- List the specific test cases you've verified --> |
| 70 | + |
| 71 | +1. |
| 72 | +2. |
| 73 | +3. |
| 74 | + |
| 75 | +## βΏ Accessibility |
| 76 | + |
| 77 | +<!--- Confirm accessibility requirements are met --> |
| 78 | + |
| 79 | +- [ ] Proper heading hierarchy maintained |
| 80 | +- [ ] ARIA labels added where needed |
| 81 | +- [ ] Color contrast requirements met |
| 82 | +- [ ] Keyboard navigation works correctly |
| 83 | +- [ ] Screen reader testing performed |
| 84 | + |
| 85 | +## π PR Checklist |
| 86 | + |
| 87 | +<!--- Review and check all applicable items --> |
| 88 | + |
| 89 | +- [ ] My code follows the project's coding style guidelines |
| 90 | +- [ ] I have tested these changes locally |
| 91 | +- [ ] I have updated the documentation accordingly |
| 92 | +- [ ] My changes generate no new warnings or console errors |
| 93 | +- [ ] I have added tests that prove my fix/feature works |
| 94 | +- [ ] All existing tests pass successfully |
| 95 | +- [ ] I have checked for and resolved any merge conflicts |
| 96 | +- [ ] I have optimized images/assets (if applicable) |
| 97 | +- [ ] I have validated all links are working correctly |
| 98 | + |
| 99 | +## π Additional Notes |
| 100 | + |
| 101 | +<!--- Add any additional context, considerations, or notes for reviewers --> |
49 | 102 |
|
50 | | -<!--- Provide any additional context or notes for the reviewers. --> |
51 | | -<!--- This might include details about design decisions, potential concerns, or anything else relevant. --> |
52 | 103 |
|
53 | 104 | --- |
54 | 105 |
|
55 | | -Thank you for contributing to our project! We appreciate your help in improving it. |
| 106 | +### π Reviewer Resources |
56 | 107 |
|
57 | | -π See [contributing instructions](https://github.com/sugarlabs/musicblocks/blob/master/README.md). |
| 108 | +- [Contributing Guide](https://github.com/sugarlabs/www-v2/blob/main/docs/CONTRIBUTING.md) |
| 109 | +- [Style Guide](https://github.com/sugarlabs/www-v2/blob/main/docs/dev_guide.md) |
| 110 | +- [Community Chat](https://matrix.to/#/#sugarlabs-web:matrix.org) |
58 | 111 |
|
59 | | -ππΎππΌ Questions: [Community Matrix Server](https://matrix.to/#/#sugar:matrix.org). |
| 112 | +Thank you for contributing to the Sugar Labs website! π |
0 commit comments