chore: standardize PR descriptions on functional change + before/after#152
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
PR descriptions now center on functional change and impact instead of a code-location walkthrough, and the repo gains the
.github/pull_request_template.mdthatAGENTS.mdalready referenced, with a Before / After section that asks for proof — CLI/API output, logs, metrics, or screenshots for UI. The inline PR-body template inAGENTS.mdis updated to match (and a couple of typos fixed).Why
The diff already shows where and how code changed. A description should add what the diff can't: the behavior that changed, who it affects, and evidence it works — shifting effort from restating code to demonstrating impact.
Before / After
Docs/templates only — no runtime behavior changes.
AGENTS.mdreferenced a template file that didn't exist; inline body used## What/## How.## What changed(functional summary + impact) +## Before / After(proof: output/logs/metrics, screenshots for UI when possible); template file now exists and matchesAGENTS.md.Risk
Checklist
Generated by Claude Code