commit

Guide Git commit messages with the HWWWn principle and bug report references.

Updated Dec 29, 2025
One-click install
npx skills add https://github.com/yumayo/MasterDataEditor --skill commit-yumayo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit
Source: https://github.com/yumayo/MasterDataEditor/tree/main/.claude/skills/commit
Command: npx skills add https://github.com/yumayo/MasterDataEditor --skill commit-yumayo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you write more effective Git commit messages by guiding you to include the "why" behind your changes, adhering to best practices.

Core Features & Use Cases

  • Enforces "Why": Prompts you to explain the reasoning behind your code changes.
  • Structured Messaging: Guides you to follow a clear format for your commit messages (Title, Why, What).
  • Use Case: When making a bug fix, this Skill ensures you not only describe what you changed but also why the change was necessary and how it addresses the root cause.

Quick Start

Use the commit skill to help write a git commit message for a bug fix.

Frequently Asked Questions about commit

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

FAQPage Schema
How do I write a good git commit message for a bug fix?

A good git commit message for a bug fix explains the reasoning behind the change, details what was modified, and references the bug report to ensure the root cause is fully documented for code review.

What should I include in a git commit message?

Git commit messages should include a clear Title, an explanation of why the changes were necessary, and a description of what was modified, adhering to the HWWWn principle for structured and informative version control logs.

Why do I need to explain the why in a commit message?

Explaining the why in a commit message provides context for code review and version control, ensuring future developers understand the reasoning behind changes rather than just the superficial details of the code modifications.

How do I structure a commit message using the HWWWn principle?

Structuring a commit message with the HWWWn principle involves organizing the log entry to clearly address the Why, What, How, When, and Where of the code changes, ensuring a highly informative and structured git commit.

What is the best way to document code changes in version control?

The best way to document code changes in version control is to use a structured commit message format that emphasizes the reasoning behind the modifications and includes references to any relevant bug reports for complete traceability.

Does this approach to writing commit messages work for general code review?

Yes, writing structured commit messages that emphasize the why behind changes provides clear context for code review, ensuring reviewers understand the necessity and root cause resolution of the submitted code modifications.