git-convention

Enforce conventional git commit message formats with English headers and optional details.

Updated Feb 28, 2025
One-click install
npx skills add https://github.com/LugeKit/dotfiles --skill git-convention
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-convention
Source: https://github.com/LugeKit/dotfiles/tree/main/skills/git_convention
Command: npx skills add https://github.com/LugeKit/dotfiles --skill git-convention

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enforces a consistent, conventional git commit message format across all changes, improving readability and governance of your version history.

Core Features & Use Cases

  • Enforces header format with a change type (feat, fix, chore, build, ci, etc.) and a concise summary.
  • Ensures a body is present after the header only if details exist, and supports a numbered Details list for multiple changes.
  • Provides examples for single-change and multi-change commits and guidance on when to apply each pattern.

Quick Start

Use this skill to structure your commit messages. Example: feat: add login feature

  • For multiple changes, list each item after a blank line using a numbered list:
  1. Implement login flow
  2. Update tests for authentication

Frequently Asked Questions about git-convention

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

FAQPage Schema
How do I enforce conventional commit messages across multiple changes?

To enforce conventional commit messages across multiple changes, structure your header with a change type prefix like feat or fix, then add a numbered Details list after a blank line to itemize each modification for clear version history governance.

What is the correct format for a conventional git commit message?

A conventional git commit message requires an English header starting with a change type prefix such as feat, fix, or chore, followed by a concise summary, and an optional body containing details only if further explanations are needed.

When should I use a numbered list in a git commit message?

You should use a numbered list in a git commit message when committing multiple changes, placing the items after a blank line following the header to clearly separate and detail each individual modification within the version control workflow.

Do I need any dependencies to automatically format conventional commits?

No dependencies are required to format conventional commits using this skill, as it directly guides the structure of English headers, change type prefixes, and optional body details without relying on external version-control components.

What is the best way to structure a single-change git commit?

The best way to structure a single-change git commit is to use a conventional prefix like feat, fix, or chore followed by a concise summary in the header, omitting the body unless you need to provide specific details about the change.