ship

Analyze diffs, create atomic conventional commits, push, and open pull requests.

Updated Jan 17, 2024
One-click install
npx skills add https://github.com/santychuycom/santychuy.com --skill ship-santychuycom
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ship
Source: https://github.com/santychuycom/santychuy.com/tree/main/.agents/skills/ship
Command: npx skills add https://github.com/santychuycom/santychuy.com --skill ship-santychuycom

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the entire process of preparing, committing, pushing, and creating a pull request for your code changes, ensuring consistency and saving valuable development time.

Core Features & Use Cases

  • Automated Commit Generation: Creates atomic, conventional commits based on code diffs.
  • End-to-End Workflow: Handles staging, committing, pushing, and PR creation in one go.
  • Use Case: After completing a feature, you can tell the AI "ship it" and it will analyze your changes, create well-formed commits, push them to your branch, and open a pull request with a detailed description.

Quick Start

Use the ship skill to commit and create a pull request for your current changes.

Frequently Asked Questions about ship

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

FAQPage Schema
How do I automate creating a pull request and conventional commits from my code diffs?

You can automate creating a pull request and conventional commits by using a workflow that analyzes your code diffs, stages atomic commits, pushes to your remote repository, and opens a PR with a rich description.

Do I need the gh CLI installed to automate pushing code and opening a GitHub pull request?

Yes, you need the gh CLI installed to automate pushing code and opening a GitHub pull request, as the workflow relies on it to handle remote repository integration and pull request creation.

What is the best way to ensure my commit messages follow conventional commit standards before shipping code?

The best way to ensure commit messages follow conventional commit standards is to automate commit generation directly from code diffs, which guarantees adherence to commit message conventions without manual formatting.

Can I trigger an end-to-end git workflow of staging, committing, and pushing with a single command?

Yes, you can trigger an end-to-end git workflow of staging, committing, and pushing with a single command, using various trigger phrases to initiate the entire process of shipping code changes.

How does automated pull request generation handle PR templates and descriptions?

Automated pull request generation handles PR templates and descriptions by analyzing your code changes and ensuring adherence to PR templates, generating a rich description for efficient code integration.