Skip to content

fix: hide pr template placeholder guidance#2411

Open
janburzinski wants to merge 1 commit into
mainfrom
jan/eng-1539-improve-pr-template-so-placeholders-arent-published
Open

fix: hide pr template placeholder guidance#2411
janburzinski wants to merge 1 commit into
mainfrom
jan/eng-1539-improve-pr-template-so-placeholders-arent-published

Conversation

@janburzinski

Copy link
Copy Markdown
Collaborator

Description

  • update pr template
Checklist
  • I kept this PR small and focused
  • I ran a self-review before opening this PR
  • I ran the relevant local checks or explained why not
  • I updated docs when behavior or setup changed
  • I added or updated tests when behavior changed, or explained why not
  • I only added comments where the logic is not obvious
  • I used Conventional Commits for commit
    messages and, when possible, the PR title

@greptile-apps

greptile-apps Bot commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR wraps all placeholder guidance text in the PR template with HTML comment tags (<!-- -->), so the hints are visible to authors when editing but are hidden in the rendered GitHub PR view.

  • Guidance text for "Description", "Related issues", "Testing", and "Screenshot/Recording" sections are now wrapped in <!-- --> comments, preventing them from cluttering the rendered PR body.
  • A minor punctuation change was also made in the "Related issues" hint — the trailing period after Fixes #123 was removed.

Confidence Score: 5/5

Safe to merge — only the PR template is changed, with no impact on application code or CI.

The change touches only the GitHub PR template file. Wrapping hint text in HTML comments is correct and produces the intended outcome; there is nothing here that could break builds, tests, or runtime behaviour.

No files require special attention.

Important Files Changed

Filename Overview
.github/PULL_REQUEST_TEMPLATE.md Placeholder guidance wrapped in HTML comments to hide them from rendered PR view; minor trailing period removed from "Related issues" hint.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Author opens PR from template] --> B{Guidance text}
    B -->|Before this PR| C[Visible as plain text in rendered PR body]
    B -->|After this PR| D[Hidden in HTML comment — visible only in editor]
    D --> E[Author fills in their own content]
    C --> F[Guidance clutters rendered PR for reviewers]
Loading

Reviews (1): Last reviewed commit: "fix: hide pr template placeholder guidan..." | Re-trigger Greptile

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.

1 participant