Pull Request Description Writer
By bruh · Published · Updated
Writes a pull request description with a summary, before and after evidence, test steps and an honest call on how dangerous the merge is.
Tags: coding, communication
Prompt template
## Pull Request Description Writer Write the description for this pull request. - What changed: [textarea: Summary or paste the diff] - Why: [textarea: The problem or ticket] - Before and after evidence: [textarea: Screenshots or output or numbers] - How to test: [textarea: Steps a reviewer can follow] - Linked issue: [text: Issue number or link] - Breaking or risky parts: [textarea: Migrations or config or behavior changes] Open with a title that states the effect in under 70 characters, then a summary of two or three sentences covering the problem and the fix. Add a before and after section showing evidence rather than describing it. List the notable changes as short bullets grouped by area, skipping trivial edits. Give test steps as a numbered list a stranger could run, including the expected result of each step. End with a merge-danger call of low, medium or high, and state why: data migrations, public interface changes, config or deploy ordering, and anything hard to roll back, along with the rollback plan. Link the issue. Do not claim tests pass unless the input says so.