pr-description

Generate PR Description

Analyze the current branch's commits and diffs against the default branch, optionally use a PR template, and output a well-formatted PR description.

Step 1: Determine the default branch

Try to find the default branch name:

git rev-parse --verify main >/dev/null 2>&1

If main exists, set DEFAULT_BRANCH=main.

Otherwise, try master:

git rev-parse --verify master >/dev/null 2>&1

If master exists, set DEFAULT_BRANCH=master.

If neither exists, try to detect via the remote HEAD:

git symbolic-ref refs/remotes/origin/HEAD 2>/dev/null | sed 's|refs/remotes/origin/||'

If this returns a branch name, use that as DEFAULT_BRANCH.

If no default branch can be determined, report "❌ Could not determine the default branch (tried main, master, and origin HEAD)" and stop.

Step 2: Gather commits and diffs

Run the following commands to collect change information:

1. Full commit log with diffs (for deep analysis):

   git log $DEFAULT_BRANCH..HEAD -p --reverse
   

2. File change summary (for the overview):

   git diff $DEFAULT_BRANCH..HEAD --stat
   

3. One-line commit list (for reference):

   git log $DEFAULT_BRANCH..HEAD --format="%h %s"
   

If no commits are found between $DEFAULT_BRANCH and HEAD (i.e., the output is empty), report "❌ No commits found between $DEFAULT_BRANCH and HEAD. Make sure you are on a feature branch with commits ahead of $DEFAULT_BRANCH." and stop.

Step 3: Search for a PR template

Check for a PR template in these locations, in priority order, using the Glob tool:

1. .github/PULL_REQUEST_TEMPLATE.md
2. .github/pull_request_template.md
3. PULL_REQUEST_TEMPLATE.md (repo root)
4. pull_request_template.md (repo root)
5. docs/PULL_REQUEST_TEMPLATE.md
6. docs/pull_request_template.md
7. .github/PULL_REQUEST_TEMPLATE/ directory (if it exists, list all .md files inside and use the first one)

Use glob patterns like **/{PULL_REQUEST_TEMPLATE,pull_request_template}.md to search efficiently.