Description
Currently, Pull Requests are submitted with varying levels of detail, making it difficult for maintainers to quickly assess the impact of changes on the core lib/ logic or the Next.js 15 frontend.
Adding a standardized PR template ensures that every contributor provides the necessary context, testing proof, and checklist verification before a review even begins.
Proposed Solution
I will implement a .github/pull_request_template.md file that includes:
* Type of Change: (Bug fix, feature, documentation, etc.)
* Description: A concise summary of "the what" and "the why."
* Compatibility Impact: A specific section to state if changes affect lib/compatibility.ts or lib/suggestions.ts.
* Proof of Work: A dedicated area for screenshots or screen recordings (essential for UI/Framer Motion changes).
* Checklist: Standard checks for squashed commits, linting (npm run lint), and mobile responsiveness.
Tasks
Why this is needed
- Uniformity: Every PR will look consistent, making the "Files Changed" tab easier to navigate.
- Verification: Forces contributors to self-review their code against the project's quality standards.
- Efficiency: Drastically reduces "back-and-forth" comments by ensuring all info is present upfront.
I can draft a template that specifically targets the Next.js 15 / TypeScript workflow used in RigCrafter. Please assign this issue to me!
Labels: chore, documentation, community, DSCWOC
Description
Currently, Pull Requests are submitted with varying levels of detail, making it difficult for maintainers to quickly assess the impact of changes on the core
lib/logic or the Next.js 15 frontend.Adding a standardized PR template ensures that every contributor provides the necessary context, testing proof, and checklist verification before a review even begins.
Proposed Solution
I will implement a
.github/pull_request_template.mdfile that includes:* Type of Change: (Bug fix, feature, documentation, etc.)
* Description: A concise summary of "the what" and "the why."
* Compatibility Impact: A specific section to state if changes affect
lib/compatibility.tsorlib/suggestions.ts.* Proof of Work: A dedicated area for screenshots or screen recordings (essential for UI/Framer Motion changes).
* Checklist: Standard checks for squashed commits, linting (
npm run lint), and mobile responsiveness.Tasks
.github/pull_request_template.md.Why this is needed
I can draft a template that specifically targets the Next.js 15 / TypeScript workflow used in RigCrafter. Please assign this issue to me!
Labels:
chore,documentation,community,DSCWOC