commit-writer

Generate conventional Git commit messages from staged changes.

2|Updated Feb 17, 2017

Search Tags:#git #code review #commit message #developer tool #convention

Ready to run

npx skills add https://github.com/John2143/dotfiles --skill commit-writer-john2143

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit-writer
Source: https://github.com/John2143/dotfiles/tree/main/.claude/skills/commit-writer
Command: npx skills add https://github.com/John2143/dotfiles --skill commit-writer-john2143

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the process of generating conventional Git commit messages, saving time and reducing the likelihood of errors.

Core Features & Use Cases

Conventional Commit Message Generation: Automatically generates commit messages based on staged git changes.
Scope and Type auto-detection: Identifies the scope and commit type from the code changes or allows for manual input.
Customization: Allows users to specify a scope and commit type if they wish to override the auto-detection.
Use Case: When you need to create a commit message for a series of changes in your codebase, this skill can generate a message that adheres to best practices.

Quick Start

Generate a commit message for your staged changes by running the command: /skill:commit-writer.

Frequently Asked Questions about commit-writer

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

FAQPage Schema

How do I generate conventional Git commit messages automatically?▼

The skill generates conventional Git commit messages by analyzing your staged changes. It provides auto-detection for commit scope and type, ensuring your development workflow maintains a consistent message format.

What is auto-detection for commit scope and type in conventional commits?▼

Auto-detection for commit scope and type identifies the correct conventional commit categories directly from your staged code changes. This mechanism analyzes the diff to determine the appropriate format without requiring manual input.

Can I manually override the commit type and scope during generation?▼

Yes, you can manually override the auto-detected commit type and scope. The skill allows you to specify and input your own scope and type values if you wish to customize the final commit message.

Does this tool work with my existing developer tool workflow for code reviews?▼

The tool integrates into your developer tool workflow by analyzing staged Git changes to produce convention-formatted messages. It helps maintain consistent commit message formats suitable for code review processes.

What is the best way to maintain a consistent commit message convention in development?▼

The best way to maintain consistent commit message conventions is to automate generation based on staged changes. This skill analyzes your code diffs to produce standardized conventional commit messages, reducing manual errors.