Skip to content

docs: add quality assurance checklist to PR template #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RishiByte merged 2 commits into from
Jun 10, 2026
+33 −11
Merged

docs: add quality assurance checklist to PR template #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1e97d5
docs: add contributor(s) @ded-furby to README [skip ci]
github-actions[bot] Jun 10, 2026
653cf2b
docs: update pull request template with QA checklist
Chirantan112 Jun 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,22 @@ Closes #
## 📂 Core Files Changed
<--write here-->

---
## 🔍 Quality Assurance Checklist
Please check the boxes that apply to your changes (`[x]`):

## 🛠️ General Checks
- [ ] **Self-Review:** I have reviewed my own code/content for typos, formatting, and clarity.
- [ ] **No Breakages:** My changes do not break existing roadmaps or application functionality.

## 📄 Documentation & Data Changes (Roadmaps, JSON, Markdown)
- [ ] **Data Validity:** All resource links, roadmap steps, and data points are accurate and up to date.
- [ ] **Formatting:** Markdown tables, bullet points, and front matter are properly formatted and easy to read.

## 🎨 UI & Code Changes (Next.js, Tailwind, TypeScript)
- [ ] **Build, Lint & Format:** The project builds locally and passes all linting/formatting checks (`npm run build` or code formatting tools run without errors).
- [ ] **Responsive Design:** If this is a UI change, it looks great on both desktop and mobile screens.

---
## 📸 Verification & Screenshots
- **UI/UX (User Interface / User Experience - how it looks and feels):**
Expand Down
28 changes: 17 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,72 +90,78 @@ Thanks to these amazing people for contributing to this project! 🎉
<tr>
<td align="center">
<a href="https://github.com/rue-eru" title="rue-eru">
<img src="https://avatars.githubusercontent.com/u/162464326?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="rue-eru"/><br />
<img src="https://avatars.githubusercontent.com/u/162464326?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="rue-eru"/><br />
<sub><b>rue-eru</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Yuvraj-Sarathe" title="Yuvraj-Sarathe">
<img src="https://avatars.githubusercontent.com/u/216678101?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="Yuvraj-Sarathe"/><br />
<img src="https://avatars.githubusercontent.com/u/216678101?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="Yuvraj-Sarathe"/><br />
<sub><b>Yuvraj-Sarathe</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Dhrubajyoti930" title="Dhrubajyoti930">
<img src="https://avatars.githubusercontent.com/u/149499573?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="Dhrubajyoti930"/><br />
<img src="https://avatars.githubusercontent.com/u/149499573?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="Dhrubajyoti930"/><br />
<sub><b>Dhrubajyoti930</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/amreshanand" title="Amresh Anand">
<img src="https://avatars.githubusercontent.com/u/225670667?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="Amresh Anand"/><br />
<img src="https://avatars.githubusercontent.com/u/225670667?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="Amresh Anand"/><br />
<sub><b>Amresh Anand</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/RishiByte" title="RishiByte">
<img src="https://avatars.githubusercontent.com/u/227175134?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="RishiByte"/><br />
<img src="https://avatars.githubusercontent.com/u/227175134?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="RishiByte"/><br />
<sub><b>RishiByte</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/nishtha-agarwal-211" title="nishtha-agarwal-211">
<img src="https://avatars.githubusercontent.com/u/242000265?v=4&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="nishtha-agarwal-211"/><br />
<img src="https://avatars.githubusercontent.com/u/242000265?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="nishtha-agarwal-211"/><br />
<sub><b>nishtha-agarwal-211</b></sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/dev" title="Kenny Hietbrink">
<img src="https://avatars.githubusercontent.com/u/12158001?v=4&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="Kenny Hietbrink"/><br />
<img src="https://avatars.githubusercontent.com/u/12158001?v=4&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="Kenny Hietbrink"/><br />
<sub><b>Kenny Hietbrink</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/maitriupadhyay03" title="maitriupadhyay03-cell">
<img src="https://github.com/maitriupadhyay03.png?s=100&s=100&s=100&s=100" width="80px;" alt="maitriupadhyay03-cell"/><br />
<img src="https://github.com/maitriupadhyay03.png?s=100&s=100&s=100&s=100&s=100" width="80px;" alt="maitriupadhyay03-cell"/><br />
<sub><b>maitriupadhyay03-cell</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/arnavbhilwariya0408" title="Arnav Bhilwariya">
<img src="https://github.com/arnavbhilwariya0408.png?s=100&s=100&s=100" width="80px;" alt="Arnav Bhilwariya"/><br />
<img src="https://github.com/arnavbhilwariya0408.png?s=100&s=100&s=100&s=100" width="80px;" alt="Arnav Bhilwariya"/><br />
<sub><b>Arnav Bhilwariya</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Anushkarshetty45" title="ANUSHKA R SHETTY">
<img src="https://avatars.githubusercontent.com/u/188852743?v=4&s=100&s=100" width="80px;" alt="ANUSHKA R SHETTY"/><br />
<img src="https://avatars.githubusercontent.com/u/188852743?v=4&s=100&s=100&s=100" width="80px;" alt="ANUSHKA R SHETTY"/><br />
<sub><b>ANUSHKA R SHETTY</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/mutthasakshi578" title="sakshimuttha578">
<img src="https://github.com/mutthasakshi578.png?s=100" width="80px;" alt="sakshimuttha578"/><br />
<img src="https://github.com/mutthasakshi578.png?s=100&s=100" width="80px;" alt="sakshimuttha578"/><br />
Comment on lines +93 to +155

@coderabbitai coderabbitai Bot Jun 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Fix malformed avatar URLs with duplicate query parameters.

Lines 93-155 contain avatar URLs with duplicate s=100 query parameters (repeated 2-10 times per URL). While browsers may be lenient, this is technically incorrect URL syntax and could cause caching or image loading issues. Only the newly added contributor on line 161 has the correct format.

For example, line 93 has:

?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100

Should be:

?v=4&s=100
🔧 Proposed fix to remove duplicate parameters 
-        <img src="https://avatars.githubusercontent.com/u/162464326?v=4&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100&s=100" width="80px;" alt="rue-eru"/><br />
+        <img src="https://avatars.githubusercontent.com/u/162464326?v=4&s=100" width="80px;" alt="rue-eru"/><br />

Apply the same fix pattern to all affected lines (93, 99, 105, 111, 117, 123, 131, 137, 143, 149, 155): keep only the first occurrence of each query parameter.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 93 - 155, The avatar img src URLs in the README for
contributors like "rue-eru", "Yuvraj-Sarathe", "Dhrubajyoti930", "Amresh Anand",
"RishiByte", "nishtha-agarwal-211", "Kenny Hietbrink", "maitriupadhyay03-cell",
"Arnav Bhilwariya", "ANUSHKA R SHETTY", and "sakshimuttha578" contain duplicate
s=100 query parameters; update each <img src="..."> URL so the query string only
includes a single instance of each parameter (e.g., ?v=4&s=100) to match the
correct format used for the newly added contributor and remove all repeated
s=100 entries.

<sub><b>sakshimuttha578</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/ded-furby" title="ded-furby">
<img src="https://avatars.githubusercontent.com/u/190979964?v=4&s=100" width="80px;" alt="ded-furby"/><br />
<sub><b>ded-furby</b></sub>
</a>
</td>
</tr>
</table>

Expand Down