commit-convention

Enforce a project's commit message convention for Git commits.

Updated Sep 6, 2025
One-click install
npx skills add https://github.com/yyoonchul/agent-rules --skill commit-convention-yyoonchul
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-convention
Source: https://github.com/yyoonchul/agent-rules/tree/main/agent-skills/skills/commit-convention
Command: npx skills add https://github.com/yyoonchul/agent-rules --skill commit-convention-yyoonchul

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Enforces a consistent commit message convention across Git commits, improving traceability and understanding of project history.

Core Features & Use Cases

  • Reads an optional .commitconventionrc in the project root to customize allowed types, scopes, and rules.
  • Provides a clear, default commit message format when no custom configuration is present.
  • Guides and standardizes commit messages to support automated tooling, changelogs, and code reviews.

Quick Start

Format the next commit message according to the project's commit convention.

Frequently Asked Questions about commit-convention

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

FAQPage Schema
How do I enforce a consistent git commit message convention?

To enforce a git commit message convention, you format messages according to predefined rules for types and scopes, ensuring traceability across project history.

Can I customize allowed types and scopes for my git workflow?

Yes, you can customize allowed types and scopes for your git workflow by adding a .commitconventionrc file in your project root to define specific rules.

What happens if there is no custom configuration file in the project root?

If no custom configuration file is present in the project root, the system applies a clear, default commit message format to standardize your git commits.

Does this commit convention apply to amending and summarizing git commits?

Yes, this commit convention applies to writing, amending, and summarizing changes in a codebase, applying the rules across all git commit modifications.

Why use a standardized commit message format for version control?

Using a standardized commit message format for version control improves project traceability and directly supports automated tooling, changelogs, and code reviews.