git-commit-formatter

Validate and format git commit messages using the Conventional Commits specification.

1.2k|296|Updated Oct 5, 2016
One-click install
npx skills add https://github.com/input-output-hk/daedalus --skill git-commit-formatter-input-output-hk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-commit-formatter
Source: https://github.com/input-output-hk/daedalus/tree/main/.agent/skills/git-commit-formatter
Command: npx skills add https://github.com/input-output-hk/daedalus --skill git-commit-formatter-input-output-hk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill streamlines the process of writing git commit messages by enforcing the Conventional Commits specification, improving code readability and maintainability.

Core Features & Use Cases

  • Commit Formatting: Validates and formats commit messages to the Conventional Commits specification.
  • Type Definitions: Supports various commit types such as feat, fix, docs, style, refactor, perf, test, and chore.
  • Scope and Description: Helps users define a scope and provide a clear, concise description for their commits.
  • Use Case: Ideal for developers and maintainers who want to ensure their commit messages are informative and follow a consistent format.

Quick Start

To format your next git commit message, simply type: git-commit-formatter --type feat --description "Add feature X to the application."

Frequently Asked Questions about git-commit-formatter

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

FAQPage Schema
How do I format git commit messages to follow the Conventional Commits standard?

To format git commit messages, you can use a validation script that enforces the Conventional Commits specification to ensure consistent commit types, scopes, and descriptions across your project.

What is the Conventional Commits specification and why use it for version control?

The Conventional Commits specification standardizes commit messages using structured types like feat, fix, or docs, which improves code readability, maintainability, and automated version control tracking.

Do I need Python to run a script that formats Conventional Commits?

Yes, you need Python installed in your environment to execute the commit message formatting script that validates and structures your git commits according to the specification.

What commit types are supported by the Conventional Commits formatting standard?

The Conventional Commits formatting standard supports various types including feat, fix, docs, style, refactor, perf, test, and chore to categorize code changes effectively.

How do I define a scope and description when writing a Conventional Commit?

You define a scope and description by passing arguments to the formatter, such as specifying the type, scope, and a concise description to generate a properly structured commit message.

Can I automate commit message validation for consistent formatting across a project?

Yes, you can automate commit message validation by integrating a formatting script into your workflow, ensuring every git commit adheres to the Conventional Commits standard automatically.