generating-commit-messages_skill

Overview

This skill enforces a mandatory commit message workflow that must be used before every git commit. It ensures commits are descriptive, follow a strict format, and document both what changed and why. Using this skill prevents generic or forbidden content in commit messages.

How this skill works

Before running git commit, you inspect staged changes with git diff --staged, analyze the modifications, and generate a commit message that follows the required structure. The output includes a concise summary line (under 50 characters, present-tense imperative) followed by a detailed description listing what changed, why, and which components/files are affected. The skill also blocks forbidden phrases and generic messages.

When to use it

• Always before every git commit in this repository
• When preparing a pull request to provide clear change context
• When multiple files or components are affected and need explanation
• When fixing bugs, adding features, refactoring, or updating docs

Best practices

• Run git diff --staged and analyze changes thoroughly before drafting the message
• Write a short, imperative summary line under 50 characters
• In the body, explain what changed, why, and list affected files/components
• Avoid generic messages and forbidden phrases; be specific and actionable
• Use present tense and start the summary with an action verb

Example use cases

• Refactor authentication module: replace JWT library, add validation, and update middleware
• Fix memory leak in session management and note production crash resolution
• Add feature to export reports including new CLI flag and updated docs
• Update third-party dependency and include migration steps and affected files