Skip to content

feat: add pull request template#1294

Merged
arnestrickmann merged 1 commit intogeneralaction:mainfrom
yashdev9274:feat-yd
Mar 6, 2026
Merged

feat: add pull request template#1294
arnestrickmann merged 1 commit intogeneralaction:mainfrom
yashdev9274:feat-yd

Conversation

@yashdev9274
Copy link
Contributor

No description provided.

@vercel
Copy link

vercel bot commented Mar 5, 2026

@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-apps
Copy link
Contributor

greptile-apps bot commented Mar 5, 2026

Greptile Summary

This PR introduces a new GitHub Pull Request template (.github/PULL_REQUEST_TEMPLATE.md) to standardise contributions to the repository. The template covers a Summary, Fixes, Snapshot, Type of change, Mandatory Tasks, and Checklist section with pnpm-specific lint/format commands matching the project's toolchain.

Key issues found:

  • Critical wording bug (line 33): The last checklist item reads "I haven't checked if new and existing unit tests pass locally with my changes" — the word haven't negates the intended meaning and should be have. As written, contributors would be checking a box to confirm they skipped testing.
  • Non-actionable mandatory task (lines 22–23): "A decent size PR without self-review might be rejected" is an informational statement, not a task a contributor can complete. It should either be rephrased as an actionable item or moved to a plain warning paragraph.
  • Missing trailing newline (line 33): The file does not end with a newline character, which is expected by POSIX tools and most editors.

Confidence Score: 3/5

  • Safe to merge after fixing the negated checklist wording on line 33, as the issue would mislead every future contributor about the testing requirement.
  • The change is a documentation-only file with no runtime impact, but the inverted checklist item (haven't vs have) on line 33 is a clear logical error that would actively mislead contributors, making it important to fix before merging.
  • .github/PULL_REQUEST_TEMPLATE.md — specifically line 33 (negated checklist item) and lines 22–23 (non-actionable task).

Important Files Changed

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]
Loading

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- [ ] 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Comment on lines +22 to +23
- [ ] I have self-reviewed the code
- [ ] A decent size PR without self-review might be rejected
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- [ ] 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

@arnestrickmann arnestrickmann merged commit a2e6792 into generalaction:main Mar 6, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants