auto-pr_skill

This skill automates the full pull request workflow, including code review, documentation generation, and PR creation, saving time and ensuring consistency.

TypeScript

76

GitHub Stars

1

Bundled Files

2 months ago

Catalog Refreshed

4 months ago

First Indexed

Readme & install

Copy the install command, review bundled files from the catalogue, and read any extended description pulled from the listing source.

Installation

Preview and clipboard use veilstrat where the catalogue uses aiagentskills.

npx veilstrat add skill qwenlm/qwen-code-examples --skill auto-pr

SKILL.md3.1 KB

Overview

This skill automates the full Pull Request workflow, from syncing the base branch to creating the PR on GitHub. It runs an automated code review diff, generates an English PR description (with template discovery), and submits the PR after your confirmation. After submission it can clean up temporary description files.

How this skill works

The skill first ensures the feature branch is up to date with the specified base branch (default: main). It computes diffs against the base, inspects changes for review notes, and scans the repository for PR templates. It generates an English PR description file and waits for your confirmation before using the GitHub CLI to create the PR, then offers to remove temporary files.

When to use it

When you want to quickly open a well-documented PR with minimal manual steps
After finishing a feature branch with unpushed commits that need review
When you want consistent PR descriptions that follow project templates
When you prefer to review an AI-generated PR description before submission

Best practices

Run the prerequisite check script before using the skill to validate environment and authentication
Ensure all changes are committed and the branch is not main or master
Confirm the generated English description and edit it if necessary before final submission
Install and authenticate gh (GitHub CLI) and verify gh auth status
Keep PR templates in the repo root or .github folder so the skill can discover them

Example use cases

Create a PR after finishing a feature branch; the skill updates the base, generates a description, and opens the PR
Batch-process small fixes: generate consistent descriptions and submit multiple PRs faster
Ensure PRs include template-specified sections (e.g., changelog, testing steps) by auto-filling descriptions
Use the code review diff output to surface potential issues before asking teammates to review

FAQ

Git, Node.js, and the GitHub CLI (gh) must be installed and gh must be authenticated (gh auth login). Run the included check script to validate.

Can I override the base branch?

Yes. The command accepts an optional base-branch argument; it defaults to main if not provided.

Will the skill push commits or only create the PR?

The skill expects changes to be committed and unpushed; it will create the PR via gh but ensure local commits are present and pushed as needed.