Write a clear Git commit message
Turn a diff or a rough description into a clean commit message that explains the why, not just the what.
Create a PR description that helps reviewers understand the change, how to test it and what to watch for.
Write a pull request description for reviewers.
Change summary or diff:
{{changes}}
Problem being solved (and link): {{problem}}
Type of change: {{type}}
How I tested it: {{testing}}
Known limitations or follow-ups: {{followups}}
Use this structure, in Markdown:
## Summary
Two or three sentences: what changed and why, written for someone with no prior context.
## Changes
A short bullet list grouped by area. Mention anything surprising.
## How to review
Where to start, which files carry the real logic, and which are mechanical (renames, generated code).
## Testing
What was run, plus step-by-step manual verification a reviewer can repeat.
## Risks and rollout
Impact on existing behavior, migrations, config or feature flags needed, and how to roll back.
## Screenshots or output
Leave a placeholder only if the change is visible.
Keep it concise and skimmable. Do not invent test results: if my testing notes are thin, list what is still unverified under Testing. Do not repeat the diff line by line.Giving the model a fixed structure and a how-to-review section saves reviewers time. The rule against inventing test results keeps the description honest.
Licensed CC0 (public domain) Version 1 · history
Turn a diff or a rough description into a clean commit message that explains the why, not just the what.
Get a prioritized code review that separates real defects from style nits, with a concrete fix for each issue.
Make tangled code easier to read and change without altering behavior, with every edit explained.
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.
Comments (0)
Sign in to join the discussion.
No comments yet. Be the first to share how it worked.