Skip to content

chore: remove placeholder text from pull request template#349

Merged
pablodeymo merged 4 commits intolambdaclass:mainfrom
dicethedev:chore/clean-pr-template
May 7, 2026
Merged

chore: remove placeholder text from pull request template#349
pablodeymo merged 4 commits intolambdaclass:mainfrom
dicethedev:chore/clean-pr-template

Conversation

@dicethedev
Copy link
Copy Markdown
Contributor

@dicethedev dicethedev commented May 7, 2026

🗒️ Description / Motivation

This PR removes placeholder instructional text from the pull request template and adds a standardized verification checklist for contributors.

The previous template included guidance comments and example prompts that appeared directly in created PRs, which added unnecessary noise and required manual cleanup before submission.

This update also introduces explicit formatting and testing checklist items to encourage contributors to verify code quality before opening PRs.


What Changed

  • Removed:

    • # Pull Request Template
    • instructional placeholder bullet points
    • example prompt text under each section
  • Added:

  • standardized verification checklist:

    • formatting checks
    • linting checks
    • full test suite validation
  • Kept:

    • the overall PR structure and headings

Correctness / Behavior Guarantees

  • No runtime or functional changes
  • No effect on code behavior
  • Improves contributor experience and PR readability
  • Encourages consistent formatting and test verification before submission

Tests Added / Run

No tests required for this change.


Related Issues / PRs

  • Related to contributor workflow improvements

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 7, 2026

Greptile Summary

This PR cleans up the PR template by removing the redundant # Pull Request Template heading and adds a verification checklist to encourage contributors to format, compile-check, test, and whitespace-verify their changes before opening a PR.

  • Removed the top-level # Pull Request Template heading; the remaining section structure is preserved unchanged.
  • Added a ✅ Verification Checklist with five cargo/git steps — the order of cargo fmt --check vs cargo fmt is reversed from the natural workflow (format first, then verify), and the file is missing a trailing newline.

Confidence Score: 4/5

Documentation-only change with no functional impact; safe to merge after addressing the two minor checklist issues.

The change touches only the PR template markdown file. The two findings are a reversed step order in the checklist (formatting check before formatting) and a missing trailing newline — neither affects any code path or contributor ability to use the template, but both are worth fixing before the template goes live.

.github/PULL_REQUEST_TEMPLATE.md — trailing newline and checklist step ordering.

Important Files Changed

Filename Overview
.github/PULL_REQUEST_TEMPLATE.md Removes the redundant # Pull Request Template heading and adds a verification checklist; cargo fmt --check and cargo fmt are listed in an unintuitive order, and the file is missing a trailing newline.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Contributor opens PR] --> B[Fill in template sections]
    B --> C{Run cargo fmt}
    C -->|Fixes formatting| D[Run cargo fmt --check]
    D -->|Passes| E[Run cargo check]
    E -->|Passes| F[Run relevant tests]
    F -->|Pass| G[Run git diff --check]
    G -->|Clean| H[Submit PR]
    D -->|Fails| C
    E -->|Fails| I[Fix compilation errors]
    I --> E
    F -->|Fail| J[Fix test failures]
    J --> F
    G -->|Whitespace issues| K[Fix whitespace]
    K --> G
Loading
Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 2
.github/PULL_REQUEST_TEMPLATE.md:28
The file is missing a trailing newline. Most editors and `git diff --check` itself will flag this, and it's inconsistent with standard POSIX text-file convention. This is also slightly ironic given the checklist includes `git diff --check`.

```suggestion
- [ ] Verified no diff issues with `git diff --check`
```

### Issue 2 of 2
.github/PULL_REQUEST_TEMPLATE.md:24-25
The checklist lists `cargo fmt --check` before `cargo fmt`. `cargo fmt --check` only reports formatting violations without fixing them, so it's more useful as a final gate *after* running `cargo fmt`. Having the check-only step first suggests contributors should report the failure and then fix it in the next step, which is a backwards workflow. Swapping the order makes the intent clearer: format first, then verify.

```suggestion
- [ ] Ran `cargo fmt`
- [ ] Ran `cargo fmt --check`
```

Reviews (1): Last reviewed commit: "chore: add formatting and test checklist..." | Re-trigger Greptile

Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Comment thread .github/PULL_REQUEST_TEMPLATE.md Outdated
Copy link
Copy Markdown
Collaborator

@MegaRedHand MegaRedHand left a comment

Choose a reason for hiding this comment

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

👍 👍

@pablodeymo pablodeymo merged commit 533f785 into lambdaclass:main May 7, 2026
2 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.

3 participants