Write a pull request description
Create a PR description that helps reviewers understand the change, how to test it and what to watch for.
Turn a diff or a rough description into a clean commit message that explains the why, not just the what.
Write a Git commit message for this change.
Convention: {{convention}}
Why the change was made (issue, bug report, goal): {{reason}}
Issue or ticket reference: {{ticket}}
Diff or summary of changes:
{{diff}}
Rules:
- Subject line: imperative mood, at most 50 characters, no trailing period, specific enough that someone scanning the log knows what changed.
- Body, wrapped at 72 characters: explain why the change was needed, what approach was taken and any tradeoff or alternative that was rejected. Do not just restate the diff line by line.
- Mention behavior changes, breaking changes or required follow-ups, if any.
- Add the ticket reference in a footer when one is given.
- If the diff contains several unrelated changes, say so and propose how to split it into separate commits with a message for each.
Give me the final message in a code block, then give two alternative subject lines.The rules push the body toward why and tradeoffs, which is what future maintainers need. The split suggestion catches overloaded commits.
Licensed CC0 (public domain) Version 1 · history
Create a PR description that helps reviewers understand the change, how to test it and what to watch for.
Draft a design doc with goals, options, a recommendation and risks, ready for team review.
Find why a build or pipeline fails in CI but not locally, and get the exact change to fix it.
Generate a practical README for a project: what it is, quick start, usage examples and contribution notes.
Plan a database, framework or infrastructure migration with phases, rollback points and verification at each step.
Convert a rambling spoken transcript into a structured doc, keeping your ideas and voice while removing the noise.
Comments (0)
Sign in to join the discussion.
No comments yet. Be the first to share how it worked.