git-commit-helper

Generate git commit messages matching repository history style and conventions.

Updated Dec 25, 2020
One-click install
npx skills add https://github.com/montenoki/dotfiles --skill git-commit-helper-montenoki
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-commit-helper
Source: https://github.com/montenoki/dotfiles/tree/main/.config/opencode/skill/git-commit-helper
Command: npx skills add https://github.com/montenoki/dotfiles --skill git-commit-helper-montenoki

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of creating commit messages that adhere to the conventions and style of your repository's commit history, ensuring consistency and efficiency in your git workflow.

Core Features & Use Cases

  • Style Consistency: Generates commit messages that match the language and format of existing commits.
  • Language Detection: Automatically detects the primary language used in the repository's commit history.
  • Template Usage: Utilizes optional .gitmessage templates for format and convention guidance.
  • Change Analysis: Reviews git changes to determine the type of commit, scope, and impact.
  • Commit Generation: Follows a structured format to create commit messages with type, scope, subject, and optional body.
  • Use Case: Ideal for developers looking to maintain a consistent commit history and ensure their commits are clear, concise, and informative.

Quick Start

Use the git-commit-helper skill to analyze your changes and generate a commit message for your next commit.

Frequently Asked Questions about git-commit-helper

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

FAQPage Schema
How do I generate git commit messages that match my repository's conventions?

To generate git commit messages matching your conventions, this Skill analyzes your repository's commit history and current changes. It detects the primary language, applies optional .gitmessage templates, and creates structured messages with type, scope, and subject.

How does language detection work for automated commit message generation?

Language detection for automated commit messages works by analyzing your repository's existing commit history. The Skill identifies the primary language used in past commits and applies that same language to the newly generated message to ensure historical consistency.

Can I use a .gitmessage template to enforce custom commit message formats?

Yes, you can use a .gitmessage template to enforce custom commit formats. The Skill utilizes this optional file for format and convention guidance, ensuring the generated commit message aligns with your specific structural requirements.

Do I need git installed to analyze code changes and generate structured commits?

Yes, you need git installed to analyze code changes and generate structured commits. The Skill requires git to perform change analysis, determining the type, scope, and impact of your modifications before generating the final commit message.

What is the best way to maintain commit history consistency across a development team?

The best way to maintain commit history consistency is to automate message generation based on existing repository conventions. This Skill reviews past commits and current changes to produce structured messages with type, scope, subject, and optional body.

Why does my generated commit message include a type, scope, and subject?

Your generated commit message includes a type, scope, and subject because the Skill follows a structured commit message format. It analyzes your git changes to determine the commit type, affected scope, and overall impact, ensuring clear and informative history.