conventional-commit

Generate Conventional Commit messages in the type(scope): description format.

Updated Jul 11, 2022
One-click install
npx skills add https://github.com/zhengfran/dotconfig --skill conventional-commit-zhengfran
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: conventional-commit
Source: https://github.com/zhengfran/dotconfig/tree/main/tools/ai/agents/skills/conventional-commit
Command: npx skills add https://github.com/zhengfran/dotconfig --skill conventional-commit-zhengfran

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents rejected git commits by generating a correctly formatted Conventional Commit message in the exact form your repo’s hooks expect.

Core Features & Use Cases

  • Standardized commit formatting: Produces messages in the required type(scope): description pattern using one of the allowed Conventional Commit types (feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert).
  • Hook-friendly workflow: Helps you inspect changes first (status/diff), then generate a message that passes validation—especially when a validate-commit-msg.sh or pre-commit tooling rejects non-conforming messages.
  • Supports rich commit structure: Encourages optional body and footer content (e.g., BREAKING CHANGE or issue references) when needed.

Quick Start

Tell the AI: “Generate a Conventional Commit message for my changes: type should be feat, scope should be agents, and the description should summarize what I changed.”

Frequently Asked Questions about conventional-commit

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

FAQPage Schema
How do I fix a git commit message that fails pre-commit validation?▼

To fix a rejected git commit message, generate a Conventional Commit in the `type(scope): description` format, using an allowed type like feat or fix, an optional scope, and an imperative description that passes the repo's hook validators.

What is the correct format for Conventional Commits?▼

The correct format for Conventional Commits is `type(scope): description`, requiring one allowed commit type such as feat, fix, or docs, an optional scope, and a concise, imperative description tailored to your repository's validation rules.

How do I write a Conventional Commit message for a git amend or reword workflow?▼

To write a Conventional Commit message for an amend or reword workflow, apply the `type(scope): description` pattern using an allowed type, optional scope, and an imperative description to satisfy previously rejected validation checks.

Does this Conventional Commit generator support optional body and footer content?▼

Yes, Conventional Commit generation supports optional body and footer content, allowing you to append details like `BREAKING CHANGE` notes or issue references alongside the required `type(scope): description` pattern.

Can I use Conventional Commits with semantic versioning and repository automation?▼

Yes, you can use Conventional Commits with semantic versioning and repository automation by generating standardized `type(scope): description` messages that hook validators recognize for automated release workflows.

Why does my git commit keep getting rejected by the validate-commit-msg hook?▼

Your git commit is rejected by the validate-commit-msg hook because the message lacks the required Conventional Commits format; you must use the `type(scope): description` pattern with an allowed type to pass validation.