| name | pr-description |
| description | Generate a complete PR description from the project's pull-request template, populated with context derived from the current branch. Trigger keywords - pr description, pull request description, generate pr. |
Skill: pr-description
Generate a complete PR description from the project's pull-request template, populated with context derived from the current branch.
Usage
/pr-description [issue-number]
issue-number (optional): GitHub issue number to link in the "Related issue(s)" section.
Instructions
When this skill is invoked, follow these steps:
1. Read the PR template
Read .github/pull-request-template.md from the repository root.
2. Analyze the current branch
Run the following commands to understand what changed:
git log <base-branch>..HEAD --oneline
git diff <base-branch>...HEAD --stat
git diff <base-branch>...HEAD
Use the commit messages and diff to understand the nature and scope of the changes.
3. Determine the PR title prefix
Based on the changes, select the most appropriate prefix mentioned in the workflow: .github/workflows/lint-pr-title.yml.
4. Generate the PR description
Produce a markdown output that fills in the template: .github/pull-request-template.md from the repository root.
5. Suggest a PR title
Output a suggested PR title with the chosen prefix. Keep it under 70 characters. Example:
feat: add new api endpoint for user authentication
6. Output format
Present the output clearly so the user can copy it directly into a GitHub PR form:
- First show the suggested title.
- Then show the full PR body as a fenced markdown block.
Guidelines
- Description bullets should focus on what changed and why, not implementation minutiae.
- Keep bullets concise (one line each).
- If there are multiple commits, group related changes into logical bullets rather than listing each commit verbatim.
- Check all "Definition of done" items that are satisfied. Leave unchecked any that still need attention (e.g., missing tests or docs) and note them for the user.
- If no issue number is provided and the branch name or commits reference an issue, suggest it to the user but do not auto-fill.
