commit-staged

Name: commit-staged
Availability: InStock
Author: iimuz

Validate staged changes against Conventional Commit rules with type validation.

3|1|Updated Aug 22, 2015

Search Tags:#automation #git #commit #validation #staging #conventional-commits

Ready to run

npx skills add https://github.com/iimuz/dotfiles --skill commit-staged-iimuz

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit-staged
Source: https://github.com/iimuz/dotfiles/tree/main/.config/copilot/skills/commit-staged
Command: npx skills add https://github.com/iimuz/dotfiles --skill commit-staged-iimuz

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Commit staged changes using Conventional Commit parameters (validates inputs).

Core Features & Use Cases

Enforces Conventional Commits on staged changes with type validation and emoji-enhanced messages.
Automates error handling for missing types or invalid inputs via the scripts in scripts/.
Only commits what is already staged, preventing accidental staged/unstaged changes.
Supports optional body content to describe the rationale behind changes.

Quick Start

Review staged changes and run the provided commit script to create a validated Conventional Commit.

Frequently Asked Questions about commit-staged

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

FAQPage Schema

How do I commit staged changes using Conventional Commits validation?▼

To commit staged changes using Conventional Commits, you run the provided commit script to validate inputs like type and optional body, ensuring only already-staged files are committed with emoji-enhanced messages.

What is the best way to enforce Conventional Commit rules on staged files?▼

Enforcing Conventional Commit rules on staged files requires running a validation script suite that checks commit types against a reference and automates error handling for invalid inputs or missing types before committing.

Can I include an optional body in my Conventional Commit message?▼

Yes, you can include an optional body in your Conventional Commit message to describe the rationale behind changes, which is supported and validated alongside the required commit type during the staging process.

Do I need to manually stage files before running a Conventional Commit script?▼

Yes, you must manually stage files before running the script, because it specifically targets already-staged changes to prevent accidentally committing unstaged modifications during the Conventional Commit process.

How does type validation work for Conventional Commits?▼

Type validation for Conventional Commits works by checking the provided commit type against a dedicated types reference file, automating error handling and preventing commits with invalid or missing type inputs.

Why does my Conventional Commit fail on staged changes with a missing type?▼

Conventional Commit validation fails on staged changes with a missing type because the script suite enforces strict type validation against a reference file, automatically rejecting inputs that do not match the defined types.