feat: add pull request template#1294
Conversation
|
@yashdev9274 is attempting to deploy a commit to the General Action Team on Vercel. A member of the Team first needs to authorize it. |
Greptile SummaryThis PR introduces a new GitHub Pull Request template ( Key issues found:
Confidence Score: 3/5
|
| Filename | Overview |
|---|---|
| .github/PULL_REQUEST_TEMPLATE.md | New PR template added with a well-structured layout, but contains a critical negated checklist item on line 33 ("haven't" instead of "have"), a non-actionable mandatory task, and a missing trailing newline. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Contributor opens a new PR] --> B[GitHub loads PULL_REQUEST_TEMPLATE.md]
B --> C[Fill in Summary & Fixes sections]
C --> D[Add Snapshot if UI changes]
D --> E[Select Type of Change]
E --> F{Mandatory Tasks}
F --> G[Self-review code]
G --> H{Checklist}
H --> I[Read contributing guide]
H --> J[pnpm run format]
H --> K[pnpm run lint]
H --> L[Add / verify tests]
I & J & K & L --> M[Submit PR]
Last reviewed commit: b386f5b
| - [ ] I have checked if my PR needs changes to the documentation | ||
| - [ ] I have checked if my changes generate no new warnings (`pnpm run lint`) | ||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
| - [ ] I haven't checked if new and existing unit tests pass locally with my changes No newline at end of file |
There was a problem hiding this comment.
Negated checklist item inverts intent
The word haven't makes this item self-defeating: contributors would be checking a box to confirm they have not verified their tests pass. This is almost certainly a copy-paste mistake and should read have to be consistent with every other item in the checklist.
| - [ ] I haven't checked if new and existing unit tests pass locally with my changes | |
| - [ ] I have checked if new and existing unit tests pass locally with my changes |
| - [ ] I have checked if my PR needs changes to the documentation | ||
| - [ ] I have checked if my changes generate no new warnings (`pnpm run lint`) | ||
| - [ ] I have added tests that prove my fix is effective or that my feature works | ||
| - [ ] I haven't checked if new and existing unit tests pass locally with my changes No newline at end of file |
There was a problem hiding this comment.
Missing newline at end of file
The file does not end with a trailing newline. Most editors and POSIX tools expect a newline after the last line of a text file. Please add a blank line after the last checklist entry.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| - [ ] I have self-reviewed the code | ||
| - [ ] A decent size PR without self-review might be rejected |
There was a problem hiding this comment.
Second "Mandatory Tasks" item is not an actionable checkbox
"A decent size PR without self-review might be rejected" is an informational warning rather than a task the contributor can actually complete. A contributor cannot meaningfully "check" this off. Consider replacing it with a concrete, actionable item (e.g., confirming the PR is scoped to a single concern) or removing it and moving the warning text to a plain paragraph above the checklist.
| - [ ] I have self-reviewed the code | |
| - [ ] A decent size PR without self-review might be rejected | |
| - [ ] I have self-reviewed the code | |
| - [ ] My PR is scoped to a single concern / feature |
No description provided.