commit-convention

Name: commit-convention
Availability: InStock
Author: spiriMirror

Apply Conventional Commits format with type, scope, and description to new commits.

307|59|Updated Jun 2, 2024

Search Tags:#git #changelog #versioning #commit #coding-standards #conventional-commits

Ready to run

npx skills add https://github.com/spiriMirror/libuipc --skill commit-convention-spirimirror

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit-convention
Source: https://github.com/spiriMirror/libuipc/tree/main/.cursor/skills/commit-convention
Command: npx skills add https://github.com/spiriMirror/libuipc --skill commit-convention-spirimirror

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Conventional commits enforce a consistent message format, improving changelogs, release notes, and automation pipelines by making intent explicit.

Core Features & Use Cases

Enforces a structured <type>(<scope>): <short summary> format for all commits.
Provides a predefined set of types (feat, fix, refactor, perf, test, docs, build, ci, chore) and guidance on scope usage.
Use Case: when preparing a release, automated tools can categorize changes by type and generate changelogs.

Quick Start

Write your commits using the Conventional Commits format, for example feat(auth): add login rate limiter.

Frequently Asked Questions about commit-convention

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

FAQPage Schema

What are conventional commits and how do they structure git commit messages?▼

Conventional commits structure git messages using a <type>(<scope>): <short summary> format. This explicit intent improves changelog generation, release notes, and automation pipelines by categorizing each change with a predefined type and optional scope.

How do I format a conventional commit for a new feature or bug fix?▼

To format a conventional commit, start with a type like feat for features or fix for bug fixes, add an optional scope in parentheses, then provide a concise description. For example: feat(auth): add login rate limiter.

What commit types should I use for documentation or refactoring changes?▼

For documentation or refactoring changes, use the docs or refactor commit types respectively. The predefined type set also includes feat, fix, perf, test, build, ci, and chore to ensure consistent versioning and clear project history.

Does using conventional commits work with automated changelog generation?▼

Yes, conventional commits work directly with automated changelog generation. By enforcing a structured format with explicit types, automated tools can easily categorize changes during a release to generate changelogs and release notes automatically.

When do I need to include an optional scope in my conventional commit message?▼

You include an optional scope in a conventional commit message to specify the section of the codebase affected, such as auth or ui. Scopes provide additional context for release notes and help categorize changes within larger software projects.