github-pr-description

Use the GitHub CLI with `gh pr create --title "Title" --body-file description.md` after writing your description to a file. The gh CLI must be installed and authenticated, which this workflow assumes is already configured.

Analyze the commits and diff between your branch and the base branch using `git log origin/main..HEAD` and `git diff origin/main..HEAD`, then classify the change type and structure the findings into summary, context, changes, and testing sections.

A good PR description includes a one-sentence summary, context explaining why the change was needed, a high-level list of changes, and step-by-step testing instructions. Optional additions are implementation details, use cases, and links to related issues.

No, you cannot create a PR from main or master, and there must be commits ahead of the base branch. The workflow verifies the current branch and commit count first and reports when there is nothing to submit.

For large diffs, the approach samples key files rather than reading everything, focusing on the most meaningful changes. Descriptions stay high-level and avoid file-by-file breakdowns unless necessary.