commit

Name: commit
Availability: InStock
Author: xantibody

Enforce Conventional Commits 1.0.0 for Git commit messages.

1|Updated Dec 12, 2024

Search Tags:#code quality #git #developer tools #version control #commit #conventional commits

Ready to run

npx skills add https://github.com/Xantibody/dotfiles --skill commit-xantibody

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/Xantibody/dotfiles/tree/main/configs/claude/skills/commit
Command: npx skills add https://github.com/Xantibody/dotfiles --skill commit-xantibody

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures all Git commit messages adhere to the Conventional Commits specification, making your commit history clean, readable, and machine-parseable.

Core Features & Use Cases

Enforces Conventional Commits: Guides users to create commits with proper type, scope, and description.
Scope Inference: Automatically suggests a scope based on staged files.
Use Case: When you need to save your work to Git, this skill helps you craft a commit message like feat(auth): implement two-factor authentication or fix: resolve critical bug in payment processing.

Quick Start

Use the commit skill to save your staged changes to git with a conventional commit message.

Frequently Asked Questions about commit

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

FAQPage Schema

How do I format Git commit messages using Conventional Commits?▼

This Skill standardizes Git commits by enforcing the Conventional Commits specification. It formats your commit type, optional scope, description, body, and footers to ensure your history is clean and machine-parseable.

Can I automatically infer commit scope from staged files?▼

Yes, you can automatically infer commit scope from staged files. The Skill analyzes staged file paths using predefined rules for Nix flakes, configuration files, and program modules to suggest an accurate scope.

What are the core components of a conventional commit message?▼

The core components of a conventional commit message include the type, optional scope, description, body, and footers. Automating these elements ensures your Git history adheres to the 1.0.0 specification.

Does this tool work with Nix flakes and configuration files?▼

Yes, the tool works with Nix flakes and configuration files by using predefined rules to infer their specific commit scopes. It analyzes these staged file paths to generate accurate conventional commit messages.

Why should I enforce conventional commits in my version control workflow?▼

Enforcing conventional commits in version control makes your commit history clean, readable, and machine-parseable. This standardization allows for automated changelog generation and clearer project tracking.