skills.rest
asarchami
asarchamiCOMMUNITY
Explore all skills by this author →
GitHub

commit-formatter

Creates git commits formatted according to Conventional Commits specification.

1|2|Updated Nov 25, 2017
Search Tags:#git#version control#commit#conventional commits#formatting#commit message
One-click install
npx skills add https://github.com/asarchami/dotfiles --skill commit-formatter-asarchami
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: commit-formatter
Source: https://github.com/asarchami/dotfiles/tree/main/dot_claude/skills/commit-formatter
Command: npx skills add https://github.com/asarchami/dotfiles --skill commit-formatter-asarchami

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, meaningful git commit messages is tedious and often inconsistent across a project. This Skill automates the process of analyzing staged changes and producing well-structured commit messages that follow the Conventional Commits standard. ## Core Features & Use Cases - Automatic Change Analysis: Runs git diff --staged to inspect changes and stages all files if nothing is staged yet. - Conventional Commits Formatting: Classifies changes into types (feat, fix, docs, refactor, test, chore, style), identifies the scope, and writes an imperative-mood summary under 72 characters. - Structured Commit Body: Always includes "What changed" and "Why" sections so every commit explains both the modifications and their motivation. - Use Case: After finishing a bug fix across several files, ask the AI to commit your work and receive a properly typed, scoped message like fix(auth): handle expired token refresh with a full explanatory body. ## Quick Start Ask the AI to commit my current changes following the Conventional Commits format.

Frequently Asked Questions about commit-formatter

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

FAQPage Schema
How do I write a Conventional Commits message?▼

A Conventional Commits message uses the format type(scope): summary, where type is feat, fix, docs, refactor, test, chore, or style. The summary uses imperative mood under 72 characters, followed by a body explaining what changed and why.

How do I commit staged changes with git automatically?▼

The Skill runs git diff --staged to inspect staged changes, stages everything with git add -A if nothing is staged, then determines the commit type and scope before running git commit with the formatted message.

What commit types does Conventional Commits support?▼

This Skill supports seven types: feat for new functionality, fix for bug fixes, docs for documentation, refactor for restructuring, test for test changes, chore for build and tooling, and style for formatting changes.

When should I split changes into multiple commits?▼

Split changes into multiple commits when they do not fit a single commit type. For example, a feature addition mixed with unrelated dependency updates should become separate feat and chore commits for a clean history.

Does the commit message need a scope?▼

The scope identifies the primary affected area such as a module or component name. It should be omitted when changes span the entire project rather than one specific subsystem.

Related Skills

Explore More Software Engineering Skills→
bdsqqqbdsqqq
59

git-ship

Stage modified files, commit with conventional commits, and push to the remote repository.

Community
Intermediate
santychuycomsantychuycom

ship

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

Official
Advanced
owenlamontowenlamont
1

python-lint-format

Automate Python code linting and formatting with pre-commit hooks.

Community
Advanced
JiangAustinJiangAustin

chinese-commit-conventions

Standardize Chinese Git commit messages with commitlint, husky, and commitizen.

Community
Intermediate