commit-workflow

Create a single Conventional Commit from current repository changes.

Updated Jul 10, 2022
One-click install
npx skills add https://github.com/samuerio/.dotfiles --skill commit-workflow-samuerio
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-workflow
Source: https://github.com/samuerio/.dotfiles/tree/main/agents/skills/commit-workflow
Command: npx skills add https://github.com/samuerio/.dotfiles --skill commit-workflow-samuerio

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps generate a precise Conventional Commit message and perform a single local commit from the current repo state, ensuring only intended changes are included.

Core Features & Use Cases

  • Analyze git status to identify unstaged and staged changes.
  • Prompt for file selection when the desired commit scope is ambiguous or multiple changes exist.
  • Validate and compose a <type>(<scope>): <subject> commit message that is <= 72 characters and contains no breaking-change markers.
  • Create exactly one commit without pushing, and report the resulting commit hash and any leftovers.
  • Guard against including secrets or large binary files.

Quick Start

Process your working tree changes and create one conventional commit with a concise, correctly formatted subject.

Frequently Asked Questions about commit-workflow

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

FAQPage Schema
How do I create a conventional commit from staged and unstaged changes?

To create a conventional commit, the workflow analyzes your current git status, prompts for file selection if changes are ambiguous, and generates a single standardized commit message without pushing to remotes.

What is the character limit for a conventional commit subject line?

A conventional commit subject line must be 72 characters or less, use an imperative mood, and follow the <type>(<scope>): <subject> format without including any breaking-change markers.

Can I automate generating a git commit message without pushing to a remote?

Yes, you can automate generating a local git commit message. The workflow creates exactly one commit from your repository changes and reports the resulting commit hash while leaving any leftovers unstaged.

How do I avoid committing secrets or large binary files in my staged changes?

To avoid committing secrets or large binary files, this workflow includes built-in guards that check your staged changes and ensure only intended files are included before finalizing the local commit.

Does this conventional commit workflow handle multiple modified files at once?

Yes, it handles multiple modified files by analyzing your git status and prompting you to select the specific files you intend to stage, ensuring the generated commit message accurately reflects the chosen scope.