Skip to content

Make PR descriptions concise and review-directed #240

Description

@knzeng-e

Outcome

A reviewer should find the result, design boundary, highest-risk review questions, and evidence without wading through repeated headings or metadata checklists.

Scope

  • Replace the current PR template with four focused sections: Outcome, Design and boundaries, Review focus, Evidence and remaining gates.
  • Keep the existing knowledge-sharing and GitHub metadata contract, but scale narrative depth to risk and manage metadata in GitHub.
  • Document the change in docs/backlog/pr-review-quality.md and align the PR writing guide.

Acceptance

  • Template still prompts for issue/backlog links, close/reference semantics, trust/failure/persistence where relevant, ordered code map, concrete review prompts, and residual gates.
  • Documentation explicitly distinguishes required information from required headings.
  • No product/runtime behavior changes.

Out of scope: rewriting historical PR descriptions or automating metadata checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions