Skip to content

Improve PR template with detailed sections and guidance - #1472

Merged
drusepth merged 1 commit into
masterfrom
claude/github-contributor-template-review-sfo1vz
Aug 20, 2026
Merged

drusepth merged 1 commit into
masterfrom
claude/github-contributor-template-review-sfo1vz

Conversation

@drusepth

Copy link
Copy Markdown
Member

Fixes #

User-facing changes

None (internal only)

Implementation notes

Updated the pull request template to provide clearer guidance for contributors:

  • Added a warning about the two live base branches (master vs tailwind-redesign) to prevent accidental PRs against the wrong branch
  • Restructured the template with four main sections: User-facing changes, Implementation notes, Testing, and Screenshots
  • Added detailed inline comments explaining what each section should contain and how to write them
  • Clarified that user-facing changes should be written in plain language suitable for release notes
  • Added guidance for marking internal-only changes
  • Improved the Testing section to document what should be included
  • Made the Screenshots section optional with clear deletion instructions

This makes it easier for contributors to understand what information is needed in each PR and helps maintain consistency in our changelog and review process.

Testing

N/A

Screenshots

None

https://claude.ai/code/session_01Nf6UpM6jN6Q5WSqTLtduC3

The old template was three bare bullets under "Changes proposed:", a dangling
"Fixes #", and a team ping. In practice the bullets always described the
implementation, so nothing in a PR body was reusable as release notes.

 - Add a "User-facing changes" section: a bulleted changelog written in plain
   language, meant to be lifted into the GitHub release (which is what
   CHANGELOG.md points at).
 - Split the old bullets into "Implementation notes" and "Testing", the latter
   matching CONTRIBUTING.md's requirement that features come with tests.
 - Add an optional "Screenshots" section for visual changes.
 - Note the base branch, since master and tailwind-redesign are both live and
   PRs have been opened against the wrong one.
 - Drop the @indentlabs/contributors ping; reviewers belong in the Reviewers
   field, where a draft PR doesn't notify the whole team.
 - Guide each field with HTML comments so unfilled prompts don't render.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Nf6UpM6jN6Q5WSqTLtduC3
@railway-app

railway-app Bot commented Aug 20, 2026 •

Copy link
Copy Markdown

🚅 Deployed to the notebook-pr-1472 environment in Notebook.ai Feature Review

Service Status Web Updated (UTC)
notebook 🕒 Building (View Logs) Web Aug 20, 2026 at 5:39 am

@railway-app
railway-app Bot temporarily deployed to Notebook.ai Feature Review / notebook-pr-1472 August 20, 2026 05:34 Destroyed
@drusepth
drusepth merged commit 392d021 into master Aug 20, 2026
1 of 2 checks passed
@drusepth
drusepth deleted the claude/github-contributor-template-review-sfo1vz branch August 20, 2026 05:43

This branch was successfully deployed

No deployments
Notebook.ai Feature Review / notebook-pr-1472 — ea371dbc Deployed Aug 20, 2026 by railway-app[bot]
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