Commit b124f6b
authored
docs(contributing): add Testing Your Changes section with SVG preview… (JhaSourav07#1602)
## Description
Fixes JhaSourav07#1343
## Pillar
- [x] 🛠️ Other (Bug fix, refactoring, docs)
## What this PR does
Adds a new "🧪 Testing Your Changes" section to CONTRIBUTING.md between
the Local Setup and Contributor Onboarding sections.
The new section covers:
- Visual browser preview URLs for testing valid badges, monthly view,
custom themes, invalid usernames, and non-existent usernames
- An explanation of the common EntityRef XML parse error and how to fix
it
- How to run the Vitest test suite (npm run test, watch mode, single
file)
- A table mapping browser output to pass/fail status so contributors
know exactly what a working vs broken response looks like
- Lint and format commands to run before every commit
Previously, CONTRIBUTING.md mentioned running npm run test and visiting
localhost:3000 in passing, but never explained what URLs to visit, what
correct output looks like, or how to interpret errors. New contributors
(especially during GSSoC) had no way to verify their changes without
asking a maintainer.
## Visual Preview
N/A — documentation change only, no SVG output affected.
## Checklist before requesting a review:
- [x] I have read the CONTRIBUTING.md file.
- [x] I have tested these changes locally.
- [x] I have run npm run format and npm run lint locally and resolved
all errors.
- [x] My commits follow the Conventional Commits format.
- [x] I have starred the repo.
- [x] I have made sure that I have only one commit to merge in this PR.1 file changed
Lines changed: 105 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| 12 | + | |
12 | 13 | | |
13 | 14 | | |
14 | 15 | | |
| |||
88 | 89 | | |
89 | 90 | | |
90 | 91 | | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
91 | 196 | | |
92 | 197 | | |
93 | 198 | | |
| |||
0 commit comments