commit-message-staged

Generate a commit message from staged Git diffs.

Updated Dec 24, 2024
One-click install
npx skills add https://github.com/BSteffaniak/nix-config --skill commit-message-staged
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-message-staged
Source: https://github.com/BSteffaniak/nix-config/tree/main/configs/opencode/skills/commit-message-staged
Command: npx skills add https://github.com/BSteffaniak/nix-config --skill commit-message-staged

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps developers quickly generate relevant commit messages by analyzing only the changes that have been staged for commit, ensuring commit messages accurately reflect the intended changes.

Core Features & Use Cases

  • Staged Changes Only: Focuses exclusively on staged files, ignoring any unstaged modifications.
  • Read-Only Output: Generates the commit message text for the user to copy, without automatically committing.
  • Use Case: After making several changes and staging only the relevant ones for a specific feature, use this Skill to draft a concise commit message that summarizes those staged changes.

Quick Start

Use the commit-message-staged skill to generate a commit message based on the current staged changes.

Frequently Asked Questions about commit-message-staged

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

FAQPage Schema
How do I generate a commit message from staged Git changes?

To generate a commit message from staged Git changes, this Skill analyzes your staged diffs to produce a structured title and description. It strictly adheres to predefined commit message rules, ensuring the output accurately reflects only the intended modifications.

Does this commit message generator consider unstaged modifications?

No, this commit message generator ignores unstaged modifications entirely. It focuses exclusively on analyzing staged files to ensure the generated commit message accurately reflects only the changes you have explicitly prepared for commit.

Can I use this to automatically execute the Git commit action?

No, you cannot use this to automatically execute the Git commit action. It provides read-only output, generating the commit message text for you to copy and use manually, which prevents unintended commits and gives you full control over the process.

What is the best way to draft a commit message for a specific feature?

The best way to draft a commit message for a specific feature is to stage only the relevant files using Git, then use this Skill. It analyzes those staged diffs to create a concise title and description summarizing the intended changes.

What format does the generated commit message follow?

The generated commit message follows a structured format with a title and description. It strictly adheres to predefined commit message rules based on the analysis of your staged Git diffs, ensuring a consistent and relevant output for your version control history.