Skip to content

Proposal: Simplify PR template to Summary + Test plan (PR #1084) #1138

@sallycr

Description

@sallycr

Background

Since we switched to squash & merge, the full PR body becomes the commit message on main. A commit audit of the last 33 merges shows the current 7-section template is generating more noise than signal:

  • Only 13 of 33 PRs used the existing template
  • Documentation Changes: 12/13 answered "None" or N/A
  • Release notes: Duplicated existing fields in 5 PRs, added nothing new in any
  • Type checkboxes: 12/13 checked exactly one box despite "check all applicable"

Proposal

PR #1084 by @craigmarker proposes replacing the 7-section template with 3 focused sections:

Old (7 sections) New (3 sections)
Type checkboxes Summary — narrative of what & why
What changed? Test plan — tests, steps, screenshots
Why? Potential risks — optional, trigger-based
How did you test it?
Potential risks
Release notes
Documentation changes

The PR also adds a /write-pull-request-description Claude Code skill that reads git diff main...HEAD and drafts a complete title + body interactively, with 9 eval test cases.

Review the full proposal

Detailed write-up with before/after examples and trade-offs:
https://personal.uberinternal.com/sally.lee/p/pr-1084-proposal.html

Team input needed

  • Does the team support adopting this template?
  • Any concerns about removing type classification (Refactor/Feature/Bug tags)?
  • Should "Potential risks" remain opt-in, or stay as a required section?

PR #1084 has one approval (cm-howard) and is ready to merge once there is team alignment.

/cc @craigmarker

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions