Generate pull request description
pr-descriptioncommandsetup L1★2,724
event-catalog/eventcatalog ↗What it does
Generate PR description markdown summarizing branch changes vs main
Best for
Pre-PR documentation when commit messages are thin and reviewers need executive summary of what changed, why, and what breaks.
Inputs
- · Current git branch with commits vs main
- · Optional user hint ($ARGUMENTS for custom context)
Outputs
- · Markdown file: pr-descriptions/branch-name-YYYY-MM-DD.md
- · PR title, what it does, files changed, breaking changes, testing checklist
Requires
- · git (log, diff, merge-base, branch commands)
Preconditions
- · Git repo with main branch
- · Current branch has commits ahead of main
- · pr-descriptions/ directory created (mkdir -p)
Failure modes
- · No commits on branch = PR description empty
- · Branch not tracking main = merge-base fails, use HEAD vs main explicitly
- · pr-descriptions/ doesn't exist = mkdir -p must run first
- · Breaking changes not documented = reviewers miss migration guidance
Trust signals
- · Analyzes full diff, not just commit messages
- · Explicitly flags breaking changes with migration guidance
- · Provides testing checklist and folder organization