Overview

This skill provides a complete, standards-based workflow for creating commits. It emphasizes staging-only changes, a conventional commit message format, and optional documentation updates, with an option to use a commit-creator agent via /commit-staged.

How This Skill Works

It begins by focusing on staged changes only. It inspects staged diffs using git diff --cached --name-only and git diff --cached, ignoring unstaged work. The commit message must follow the {type}: brief description format (types include feat, fix, refactor, docs, style, test, build) and can include motivation; commits are formatted using HEREDOC for proper formatting.

When to Use It

• When you want to commit these changes or write a commit message
• When you need to stage and commit files
• When creating a commit for a feature, fix, refactor, or docs update
• When you run /commit-staged or /commit-creator commands
• When you want to verify the commit format and that documentation is aligned with changes

Quick Start

1. Step 1: Run /commit-staged [context] or stage the changes you want to include
2. Step 2: Review staged diffs with git diff --cached --name-only and git diff --cached
3. Step 3: Create the commit using the required {type}: description format (use HEREDOC) and update docs if needed

Best Practices

• Analyze staged files before writing the message
• Keep the first line under 50 chars
• Use active voice in the commit message
• Reference related code if helpful
• One logical change per commit

Example Use Cases

• feat: implement user authentication system
• fix: resolve memory leak in data processing pipeline
• refactor: restructure API handlers to align with project architecture
• docs: update README with new setup instructions
• test: add unit tests for new authentication flow

Frequently Asked Questions