skills.rest
li3p
li3pCOMMUNITY
Explore all skills by this author →
GitHub

ship

Generate a reviewer-ready PR description from branch commits and diffs.

Updated Apr 21, 2026
Search Tags:#commits#branch#pr#code-review#diffs#pull-request
One-click install
npx skills add https://github.com/li3p/skills --skill ship-li3p
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ship
Source: https://github.com/li3p/skills/tree/main/skills/ship
Command: npx skills add https://github.com/li3p/skills --skill ship-li3p

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ship automates PR preparation by analyzing the current branch's commits, diffs, and test outcomes to generate a reviewer-friendly description.

Core Features & Use Cases

  • Identify base and current branches, compute how far ahead/behind you are, and quantify diff size.
  • Run the relevant test suite before drafting the PR; halt on failures and surface the results.
  • Inspect the actual diff (not just commit messages) to ensure changes are coherent.
  • Flag branch hygiene issues: very large diff, too many commits, generated files, missing tests, or preflight blockers.
  • Draft a structured PR description following the recommended sections: Summary, Changes, How to Test, Risk Assessment, and Related Issues.

Quick Start

Run Ship on the repository while on the feature branch to generate a reviewer-ready PR description.

Frequently Asked Questions about ship

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a pull request description from branch commits and diffs?▼

Generating a PR description from commits involves inspecting the actual diff, running tests, and flagging branch hygiene issues like too many commits or generated files before drafting the structured content.

What should a reviewer-ready PR description include?▼

It must contain structured sections for Summary, Changes, How to Test, Risk Assessment, and Related Issues, generated by validating base versus feature branches and assessing diff size.

Can I check branch hygiene and diff size before submitting a pull request?▼

Checking branch hygiene involves quantifying diff size, calculating ahead/behind commits, and flagging generated files, missing tests, or preflight blockers to ensure changes are coherent before PR submission.

How do I validate base and feature branches before creating a PR?▼

You validate base and feature branches by identifying them, computing ahead/behind calculations, and running the test suite to surface failures before generating the PR content.

Does PR drafting stop if tests fail on the feature branch?▼

PR drafting halts on test failures and surfaces the results, acting as a preflight blocker to prevent generating a PR description for a branch with failing tests.

Related Skills

Explore More Software Engineering Skills→
thurstonsandthurstonsand

pr

Analyze commits since divergence and draft editable pull request descriptions.

Community
Advanced
lie5860lie5860
30

chinese-git-workflow

Generate Git workflows for Gitee, Coding.net, and JihuLab/GitLab.

Community
Intermediate
linuxfoundationlinuxfoundation
12

preflight

Runs mechanical pre-PR checks covering license headers, formatting, lint, build, and commit verification.

Official
Intermediate
OlatisunkanmiOlatisunkanmi
8

pr-summary

Generate concise pull request summaries from branch diffs and git history.

Community
Basic