Documentation
README
Generating PR Descriptions
When to use
- Preparing a pull request for review and need a comprehensive description
- Generating a PR title automatically from commit message analysis
- Classifying the type of change (bug fix, feature, breaking change)
- Saving a reusable PR description to
docs/pr-descriptions/<branch-name-with-hyphens>.md
Skip when
- The PR is a single trivial commit with an obvious description
- A PR description already exists and does not need regeneration
- The branch has no commits beyond the base branch
Process
1. Git Branch Analysis - CRITICAL: Branch-Only Scope
This is the opening of the README. Read the full README on GitHub.