conventional-commits

Enforce Conventional Commits structure for commit messages.

124|19|Updated Jul 11, 2022
One-click install
npx skills add https://github.com/axone-protocol/contracts --skill conventional-commits-axone-protocol
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: conventional-commits
Source: https://github.com/axone-protocol/contracts/tree/main/.agents/skills/conventional-commits
Command: npx skills add https://github.com/axone-protocol/contracts --skill conventional-commits-axone-protocol

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Keeping commit messages consistent is hard, leading to confusing histories and manual git blame work. This guide provides a clear, enforceable standard to improve traceability, code reviews, and automated tooling.

Core Features & Use Cases

  • Enforces Conventional Commits structure for every new change
  • Provides guidance on type, scope, subject, and breaking changes
  • Supports automated changelogs and semantic versioning workflows in team projects

Quick Start

Use the conventional-commits guide to craft a properly formatted commit message for the latest change.

Frequently Asked Questions about conventional-commits

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

FAQPage Schema
What are conventional commit messages and when do I need them in git?

Conventional commit messages standardize git history by enforcing rules for message structure. You need them in software development teams practicing semantic versioning and automated changelogs to improve traceability and code reviews.

How do I structure a commit message for automated changelogs and semantic versioning?

Structure a commit message by adhering strictly to type, scope, and subject conventions. This standardized format provides clear rules that guide usage and support automated changelog workflows across multiple repositories.

How do I indicate breaking changes in a conventional commit message?

Indicate breaking changes by following the provided guidance on type, scope, subject, and breaking changes within the conventional commit structure. This ensures clear communication of major modifications in the code history.

Can I use conventional commits across multiple repositories with different team workflows?

Yes, conventional commits apply to software development teams working across multiple repositories. The standard provides clear, enforceable rules for message structure that adapt to various team workflows practicing semantic versioning.

What's the best way to enforce a standardized and readable git commit history?

The best way to enforce a readable git commit history is applying a clear standard for commit messages. This guide provides enforceable rules for message structure to solve confusing histories and reduce manual git blame work.

Why does inconsistent git commit history make code reviews harder?

Inconsistent git commit history makes code reviews harder because it leads to confusing logs and requires manual git blame work. Standardized commit messages improve traceability and enable automated tooling to process changes efficiently.