skills.rest
Amit-Hemo
Amit-HemoCOMMUNITY
Explore all skills by this author →
GitHub

git-commit-formatter

Format git commit messages to conform to the Conventional Commits specification.

Updated Aug 27, 2024
Search Tags:#git#formatting#version-control#commit-message#conventional-commits#developer-tooling
One-click install
npx skills add https://github.com/Amit-Hemo/Crypto-Balance-System --skill git-commit-formatter-amit-hemo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: git-commit-formatter
Source: https://github.com/Amit-Hemo/Crypto-Balance-System/tree/main/.agent/skills/git-commit-formatter
Command: npx skills add https://github.com/Amit-Hemo/Crypto-Balance-System --skill git-commit-formatter-amit-hemo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

In many projects, inconsistent or vague commit messages slow code reviews and release automation. This skill helps ensure every commit message follows the Conventional Commits format, improving clarity and tooling compatibility.

Core Features & Use Cases

  • Enforces the Conventional Commits structure: type(scope)?: description
  • Suggests appropriate scope based on changed files and components
  • Provides actionable examples and validation guidance to ensure compliance
  • Useful for pre-commit hooks, CI checks, and automated changelog generation

Quick Start

Provide your change details and request a Conventional Commits formatted message.

Frequently Asked Questions about git-commit-formatter

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

FAQPage Schema
How do I format git commit messages to follow Conventional Commits?▼

Format git commit messages by providing your change details to generate Conventional Commits compliant syntax. The formatter enforces the required type, optional scope, and description structure for feature development, bug fixes, docs updates, and refactors.

What is the Conventional Commits structure for a git commit message?▼

The Conventional Commits structure for a git commit message is type(scope)?: description. This format enforces clarity and tooling compatibility, optionally supporting BREAKING CHANGE footers when needed for significant updates.

Can I use Conventional Commits formatting for git workflows involving refactoring and docs updates?▼

Yes, you can use Conventional Commits formatting for typical Git workflows involving refactoring and docs updates. The formatter applies the correct type and suggests appropriate scope to ensure every commit message follows the specification across various development tasks.

How do I add a BREAKING CHANGE footer to a conventional commit message?▼

To add a BREAKING CHANGE footer to a conventional commit message, you provide the details of your breaking modification. The formatter supports BREAKING CHANGE footers when needed, ensuring the syntax correctly flags major updates for release automation and changelog generation.

Does this commit message formatter suggest a scope based on changed files?▼

Yes, this commit message formatter suggests an appropriate scope based on changed files and components. It provides actionable examples and validation guidance to ensure your commit message achieves full Conventional Commits compliance for pre-commit hooks and CI checks.

Related Skills

Explore More Software Engineering Skills→
dudusoardudusoar

git-log

Generate Conventional Commits messages and update GIT_LOG.md documentation.

Community
Basic
OnClickListener2048OnClickListener2048

chinese-commit-conventions

Enforce Chinese commit conventions and generate changelogs from Git history.

Community
Intermediate
vuralserhat86vuralserhat86
43

git_workflow

Guide Git branching strategies, commit conventions, and merge workflows.

Community
Intermediate
adrhilladrhill
40

commit

Create Git commits adhering to the Conventional Commits specification.

Community
Intermediate