Snapdock Commit Message Guide

Generate Git commit messages from staged changes using Conventional Commits.

Updated Feb 4, 2025
One-click install
npx skills add https://github.com/Heunsig/snapdock --skill snapdock-commit-message-guide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Snapdock Commit Message Guide
Source: https://github.com/Heunsig/snapdock/tree/main/.agents/skills/commit-message
Command: npx skills add https://github.com/Heunsig/snapdock --skill snapdock-commit-message-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill automates the generation of Git commit messages, ensuring consistency with the Conventional Commits specification and project-specific patterns, saving developers time and improving commit history clarity.

Core Features & Use Cases

  • Automated Commit Message Generation: Analyzes staged changes and recent commit history to suggest relevant commit messages.
  • Conventional Commits Adherence: Enforces a structured format (<type>(<scope>): <description>).
  • Pattern Matching: Maps file changes to appropriate commit types and scopes based on project conventions.
  • Use Case: When you've finished implementing a new feature in a component, you can ask the AI to generate a commit message, and it will suggest something like feat(ProjectCard): add date display after analyzing your changes.

Quick Start

Use the commit message skill to generate a commit message for your staged changes.

Frequently Asked Questions about Snapdock Commit Message Guide

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

FAQPage Schema
How do I generate conventional commit messages automatically from staged changes?

To generate conventional commit messages automatically, this Skill analyzes your staged Git changes and recent commit history to determine the appropriate type, scope, and description. It outputs a structured message adhering to the `<type>(<scope>): <description>` format.

What is the conventional commits format for writing Git commit messages?

The conventional commits format structures Git messages using a specific syntax: `<type>(<scope>): <description>`. This specification improves commit history clarity and helps automate code review by mapping file changes to appropriate commit types and scopes based on project conventions.

How do I map file changes to appropriate commit types and scopes for my project?

You map file changes to commit types and scopes by matching staged code modifications against project-specific patterns. The Skill reads recent commit history and validates the proposed message format against your project's conventions to ensure the type and scope align with previous entries.

Can I validate my Git commit message format against existing project conventions?

Yes, you can validate Git commit message format against project conventions. The Skill checks your staged changes and recent history to ensure the generated message follows the Conventional Commits specification and matches the specific patterns established in your repository.

Does this commit message generator work with custom project patterns?

Yes, the commit message generator works with custom project patterns by analyzing recent commit history. It maps your staged file changes to the appropriate type and scope, validating the output against your repository's established conventions to ensure consistency.

Why should I use conventional commits over standard Git commit messages?

You should use conventional commits over standard Git messages to enforce a structured format that improves commit history clarity. By standardizing types and scopes, this approach saves developer time during code review and makes automated processing of repository history more reliable.