Create pull request template for contributions#125
Conversation
Add a pull request template to standardize submissions.
|
@Nitya-003 is attempting to deploy a commit to the Dot_NotSam's projects Team on Vercel. A member of the Team first needs to authorize it. |
Thanks for creating a PR for your Issue!
|
📝 WalkthroughWalkthroughA standardized pull request template file is added to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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: 4
🧹 Nitpick comments (1)
.github/pull_request_template.md (1)
30-32: Consider using Markdown image syntax as the placeholder.
[Insert Image]renders as plain text. Using a commented-out Markdown image placeholder makes the expected format immediately obvious to contributors.✏️ Suggested fix
| Desktop View | Mobile View | |--------------|-------------| -| [Insert Image] | [Insert Image] | +|  |  |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/pull_request_template.md around lines 30 - 32, Replace the plain-text placeholders "[Insert Image]" in the PR template table row "| Desktop View | Mobile View |" with a commented-out Markdown image placeholder so contributors see the expected image syntax; use an HTML comment that contains a Markdown image alt text and a suggested path (e.g., a commented example like a Markdown image for Desktop and Mobile) to indicate where and how to add screenshots.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/pull_request_template.md:
- Line 41: Update the checklist item "[ ] **DSCWOC '26**: I have tagged the
project maintainer and used the correct labels." to include scoring guidance:
either expand that line to briefly summarize the scoring rubric (point tiers,
difficulty labels, submission deadline) or add a new "### DSCWOC '26" subsection
below the checklist with a short scoring rubric and a link to the detailed
scoring docs/Issue `#122`; ensure the new text explicitly mentions how PRs are
scored (e.g., points per difficulty label and deadline) and where to find the
full rules.
- Line 4: Replace the placeholder string "**Fixes # (issue number)**" in the
pull request template with a format that places the issue number immediately
after the hash, e.g. "**Fixes `#issue_number`**" or a clearer instruction like
"**Fixes #\<issue number\>**" so contributors don't introduce a space (avoid
"Fixes # 42"); update the template text to show the correct example and/or
guidance so GitHub's auto-close keyword triggers properly.
- Line 23: Remove the trailing inline ">" and place the blockquote marker at the
start of a new line so Markdown renders correctly: change the line that
currently reads "*If yes, please describe the logic change:* >" to just "*If
yes, please describe the logic change:*" and add a new subsequent line starting
with ">" (e.g., "> ") to begin the blockquote where contributors can enter their
explanation.
- Around line 36-41: Add the missing "squash commits" checklist item under the
"Contributor Checklist" section: update the checklist (the block starting with
"## Contributor Checklist") to include a line like "- [ ] **Squash commits**: I
have squashed or rebased to produce a clean commit history before merge" so
contributors must confirm they squashed commits before merging.
---
Nitpick comments:
In @.github/pull_request_template.md:
- Around line 30-32: Replace the plain-text placeholders "[Insert Image]" in the
PR template table row "| Desktop View | Mobile View |" with a commented-out
Markdown image placeholder so contributors see the expected image syntax; use an
HTML comment that contains a Markdown image alt text and a suggested path (e.g.,
a commented example like a Markdown image for Desktop and Mobile) to indicate
where and how to add screenshots.
| ## Description | ||
| Provide a clear and concise summary of the changes. What problem does this PR solve? | ||
|
|
||
| **Fixes # (issue number)** |
There was a problem hiding this comment.
Fixes # (issue number) won't trigger GitHub's auto-close.
GitHub's issue auto-close keyword requires the # to be immediately followed by the issue number (e.g., Fixes #42``). The current placeholder has a space and descriptive text after #, so contributors who fill it in by replacing `(issue number)` with just a number will still have a space (`Fixes # 42`) that breaks the linkage.
✏️ Suggested fix
-**Fixes # (issue number)**
+**Fixes `#ISSUE_NUMBER`**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **Fixes # (issue number)** | |
| **Fixes `#ISSUE_NUMBER`** |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/pull_request_template.md at line 4, Replace the placeholder string
"**Fixes # (issue number)**" in the pull request template with a format that
places the issue number immediately after the hash, e.g. "**Fixes
`#issue_number`**" or a clearer instruction like "**Fixes #\<issue number\>**" so
contributors don't introduce a space (avoid "Fixes # 42"); update the template
text to show the correct example and/or guidance so GitHub's auto-close keyword
triggers properly.
| - [ ] **lib/suggestions.ts**: Updates to the AI/Smart recommendation logic. | ||
| - [ ] **lib/data.ts**: Modifications to the component database. | ||
|
|
||
| *If yes, please describe the logic change:* > |
There was a problem hiding this comment.
Inline > won't render as a Markdown blockquote.
The > at the end of the line renders as a literal > character. A blockquote must start at the beginning of a new line.
✏️ Suggested fix
-*If yes, please describe the logic change:* >
+*If yes, please describe the logic change:*
+> 🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/pull_request_template.md at line 23, Remove the trailing inline ">"
and place the blockquote marker at the start of a new line so Markdown renders
correctly: change the line that currently reads "*If yes, please describe the
logic change:* >" to just "*If yes, please describe the logic change:*" and add
a new subsequent line starting with ">" (e.g., "> ") to begin the blockquote
where contributors can enter their explanation.
| ## Contributor Checklist | ||
| - [ ] **Linting**: I have run `npm run lint` and fixed all warnings. | ||
| - [ ] **Next.js 15**: Verified the build works with the App Router. | ||
| - [ ] **Responsiveness**: Tested on mobile and tablet breakpoints. | ||
| - [ ] **Mermaid**: If I updated the README, I verified the Mermaid diagrams render correctly. | ||
| - [ ] **DSCWOC '26**: I have tagged the project maintainer and used the correct labels. |
There was a problem hiding this comment.
Missing required checklist item: commit squashing.
Issue #122 explicitly requires a checklist item for squashing commits before merge. This item is absent from the Contributor Checklist.
✏️ Suggested fix
- [ ] **Linting**: I have run `npm run lint` and fixed all warnings.
+- [ ] **Commits**: I have squashed my commits into a single, meaningful commit message.
- [ ] **Next.js 15**: Verified the build works with the App Router.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/pull_request_template.md around lines 36 - 41, Add the missing
"squash commits" checklist item under the "Contributor Checklist" section:
update the checklist (the block starting with "## Contributor Checklist") to
include a line like "- [ ] **Squash commits**: I have squashed or rebased to
produce a clean commit history before merge" so contributors must confirm they
squashed commits before merging.
| - [ ] **Next.js 15**: Verified the build works with the App Router. | ||
| - [ ] **Responsiveness**: Tested on mobile and tablet breakpoints. | ||
| - [ ] **Mermaid**: If I updated the README, I verified the Mermaid diagrams render correctly. | ||
| - [ ] **DSCWOC '26**: I have tagged the project maintainer and used the correct labels. |
There was a problem hiding this comment.
DSCWOC '26 scoring instructions are missing.
Issue #122 requires "tagging/scoring instructions" for DSCWOC '26. The current checklist item only covers tagging and labels; there is no guidance on how PRs are scored (e.g., point tiers, difficulty labels, or submission deadlines).
Consider expanding this item or adding a dedicated ### DSCWOC '26 sub-section with a brief scoring rubric or a link to the relevant scoring documentation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/pull_request_template.md at line 41, Update the checklist item "[ ]
**DSCWOC '26**: I have tagged the project maintainer and used the correct
labels." to include scoring guidance: either expand that line to briefly
summarize the scoring rubric (point tiers, difficulty labels, submission
deadline) or add a new "### DSCWOC '26" subsection below the checklist with a
short scoring rubric and a link to the detailed scoring docs/Issue `#122`; ensure
the new text explicitly mentions how PRs are scored (e.g., points per difficulty
label and deadline) and where to find the full rules.
SamXop123
added
documentation
2 participants
Add a pull request template to standardize submissions.
Related Issue
Closes #122
Description
This PR introduces a standardized Pull Request Template (
.github/pull_request_template.md).As RigCrafter grows during the DSCWOC '26 period, we need a consistent way to review contributions. This template ensures that every contributor provides technical context regarding the Next.js 15 frontend and the compatibility logic in the lib/ folder before their code is reviewed.
Key Changes
lib/compatibility.tsandlib/suggestions.tsto protect the "brain" of the app.npm run lintand mobile responsiveness verification.Quality Checklist
.github/pull_request_template.md.Summary by CodeRabbit