conventional-commits

Generate and validate Conventional Commits v1.0.0 messages for git changes.

1|Updated Mar 27, 2026
One-click install
npx skills add https://github.com/minfengyuan/harness-knowledge-base --skill conventional-commits-minfengyuan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: conventional-commits
Source: https://github.com/minfengyuan/harness-knowledge-base/tree/main/skills/conventional-commits
Command: npx skills add https://github.com/minfengyuan/harness-knowledge-base --skill conventional-commits-minfengyuan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill turns repository diffs and existing commit text into a single, spec-compliant Conventional Commit message or evaluates and rewrites non-compliant messages to match the v1.0.0 spec, removing guesswork and style debates.

Core Features & Use Cases

  • Generate: Create one best Conventional Commit message from staged changes, a specified diff, or a user-provided summary with an appropriate type, optional scope, and concise description.
  • Analyze & Rewrite: Validate existing commit lines against Conventional Commits v1.0.0, list violations, and provide a faithful compliant rewrite.
  • Reference-driven: Uses the included v1.0.0 reference for exact validation rules and rewrite patterns, and adds breaking-change markers or footers only when required.

Quick Start

Generate a Conventional Commit message for the staged changes and ensure it follows the Conventional Commits v1.0.0 specification.

Frequently Asked Questions about conventional-commits

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

FAQPage Schema
How do I generate a conventional commit message from staged git changes?

You can generate a conventional commit message from staged git changes by providing the staged diff; the Skill analyzes it and produces a single spec-compliant header with an appropriate type, optional scope, and concise description per the v1.0.0 format.

How do I validate existing git commit messages against the Conventional Commits specification?

Validating existing git commit messages involves checking your commit text against the v1.0.0 reference rules; the Skill returns a list of specific violations and provides a faithful compliant rewrite of any non-compliant message.

What is the Conventional Commits v1.0.0 format and when do I need a BREAKING CHANGE footer?

The Conventional Commits v1.0.0 format structures commit headers with a type, optional scope, and description; a BREAKING CHANGE footer is required when changes introduce incompatible API modifications, which the Skill adds only when necessary.

Can I rewrite non-compliant commit messages to follow the Conventional Commits spec?

Yes, you can rewrite non-compliant commit messages to follow the specification; the Skill evaluates existing commit text, identifies formatting violations against the v1.0.0 reference, and outputs a faithful compliant rewrite.

Do I need any external dependencies or tools to validate commit messages?

No external dependencies or tools are required to validate commit messages; the Skill uses an included v1.0.0 reference for exact validation rules and rewrite patterns, functioning standalone without additional packages.

What's the best way to create a commit message from a user-provided summary?

The best way to create a commit message from a user-provided summary is to supply your text summary; the Skill generates one best Conventional Commit message with an appropriate type, optional scope, and concise description compliant with the v1.0.0 spec.