docs: add quality assurance checklist to PR template#137
Open
Chirantan112 wants to merge 2 commits into
Open
Conversation
|
@Chirantan112 is attempting to deploy a commit to the Rishi Bhardwaj's projects Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThis PR adds contributor guidance and updates project credits. A quality assurance checklist was appended to the pull request template covering self-review, documentation, and UI verification. The README contributors section was refreshed with updated avatar links and includes a new contributor entry. ChangesDocumentation and Contributor Updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with 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.
Inline comments:
In `@README.md`:
- Around line 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.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 284b424c-cc2a-49d0-ac7f-cb290ab164fb
📒 Files selected for processing (2)
.github/PULL_REQUEST_TEMPLATE.mdREADME.md
Comment on lines
+93
to
+155
| <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 /> |
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔗 Related Issue
Closes #123
📝 Description of Changes
Added a comprehensive Quality Assurance (QA) checklist to the existing pull request template. This checklist helps contributors verify their work across documentation, data updates, and UI/code changes before submitting, helping to reduce review back-and-forth.
🏷️ Proposed Labels
📂 Core Files Changed
.github/PULL_REQUEST_TEMPLATE.md🤖 AI Assistance Declaration
Did you use an AI tool to write or assist with this code OR Pull Request?
The checklist has been injected right in the middle of the existing template format, keeping your original header sections and the final verification pledge perfectly intact.
✅ The "I Swear I Didn't Break Anything" Pledge
Summary by CodeRabbit
Documentation
Chores