Skip to content

Create pull request template for contributions #125

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
SamXop123 merged 1 commit into from
Feb 23, 2026
Merged

Create pull request template for contributions #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 50 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## Description
Provide a clear and concise summary of the changes. What problem does this PR solve?

**Fixes # (issue number)**

@coderabbitai coderabbitai Bot Feb 22, 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 | 🟡 Minor

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.

Suggested change
**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.


---

## Type of Change
- [ ] New Feature (New PC component or category)
- [ ] Bug Fix (Compatibility logic error or UI glitch)
- [ ] Documentation (README, Mermaid diagrams, or comments)
- [ ] Refactor (Code cleanup in `lib/` or `app/`)
- [ ] UI/UX Update (Framer Motion animations or shadcn/ui tweaks)

---

## Compatibility & Logic Impact
Does this change affect the core building engines?
- [ ] **lib/compatibility.ts**: Changes to socket matching, wattage, or form factors.
- [ ] **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:* >

@coderabbitai coderabbitai Bot Feb 22, 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 | 🟡 Minor

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.


---

## Proof of Work
**Mandatory for UI/UX changes.** Please attach screenshots or a screen recording showing the new feature or fix in action (especially Framer Motion transitions).

| Desktop View | Mobile View |
|--------------|-------------|
| [Insert Image] | [Insert Image] |

---

## 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.
Comment on lines +36 to +41

@coderabbitai coderabbitai Bot Feb 22, 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 | 🟡 Minor

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.

@coderabbitai coderabbitai Bot Feb 22, 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 | 🟡 Minor

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.


---

## Acknowledgments
- [ ] I have read the **Code of Conduct**.
- [ ] I am submitting this PR under the **MIT License**.

---
*Built with love for RigCrafter*