commit-message

Generate structured commit messages with imperative subject lines and detailed bodies.

13|1|Updated Apr 8, 2010
One-click install
npx skills add https://github.com/nb/dotfiles --skill commit-message-nb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-message
Source: https://github.com/nb/dotfiles/tree/main/skills/commit-message
Command: npx skills add https://github.com/nb/dotfiles --skill commit-message-nb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users write commit messages that clearly communicate the purpose and impact of code changes, improving collaboration and code maintainability.

Core Features & Use Cases

  • Subject Line Generation: Guides users to create concise, imperative subject lines.
  • Body Content Guidance: Provides structure for explaining the 'why' and 'how' of changes.
  • Best Practice Adherence: Ensures messages follow established conventions for clarity and consistency.
  • Use Case: When you've just finished a complex bug fix, use this Skill to help you articulate the problem, the solution, and the reasoning behind your code changes in a standard commit message format.

Quick Start

Use the commit-message skill to help write a commit message for a new feature.

Frequently Asked Questions about commit-message

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

FAQPage Schema
How do I write a clear git commit message for a complex code change?

A well-structured commit message uses a concise imperative subject line and a detailed body to explain the why and how of code changes, ensuring clear communication and effective version control for software development.

What is the best format for a git commit message?

The best format for a git commit message follows established conventions, using an imperative subject line and a body that provides context. This structure enforces conciseness and clarity for effective version control and code review.

Why do git commit messages need an imperative subject line?

Git commit messages need an imperative subject line to directly instruct what the code change does. This best practice enforces conciseness and clarity, making version control history easier to read and review.

Does this commit message generator work without any external dependencies?

Yes, this commit message generator works without external dependencies. It provides built-in guidance for structuring commit message subject lines and body content to facilitate clear communication of code changes.

How do I explain the reasoning behind a bug fix in a commit message?

To explain the reasoning behind a bug fix in a commit message, use the body content section to articulate the problem, the implemented solution, and the context. This helps maintain clear code maintainability.