commit-message-staged-write

Generate Git commit messages from staged changes and write them for commit tools.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of Git commit messages by analyzing only your staged changes, ensuring your commit messages accurately reflect what's being committed without including unintended modifications.

Core Features & Use Cases

  • Staged Changes Only: Generates commit messages based exclusively on staged files, ignoring unstaged modifications.
  • Pre-filled Commit Editor: Automatically writes the generated message to a file that git commit reads, pre-filling your editor.
  • LazyGit Integration: Also writes the message to a file that lazygit uses to pre-fill its commit panel.
  • Use Case: After staging several related changes for a feature, run this skill to get a well-formed commit message that summarizes exactly those staged changes, ready to be committed.

Quick Start

Run the commit-message-staged-write skill to generate a commit message from your staged changes.

Frequently Asked Questions about commit-message-staged-write

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

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

To generate a git commit message from staged changes, this skill analyzes your staged files while ignoring unstaged modifications, writing the context-specific summary to a file that pre-fills your commit editor.

How does this skill handle unstaged modifications when writing commit messages?

This skill handles unstaged modifications by completely ignoring them, ensuring the generated commit message accurately reflects only the files you have staged for the commit.

Can I use this automated commit message generator with lazygit?

Yes, you can use this with lazygit because it automatically writes the generated commit message to the specific file output that lazygit reads to pre-fill its commit panel.

Do I need Git hooks to auto-generate commit messages for staging?

Yes, you need Git hooks and specific file outputs for integration to successfully auto-generate and write commit messages based on your staged changes.

What is the best way to automate development workflow commit messages for git?

The best way to automate development workflow commit messages is to run this skill after staging related files, which generates a well-formed summary and pre-fills the commit editor automatically.