grimoire-commit

Generate conventional commit messages from staged changes and grimoire context.

Updated Jan 26, 2025
One-click install
npx skills add https://github.com/jlissner/lissner.io --skill grimoire-commit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: grimoire-commit
Source: https://github.com/jlissner/lissner.io/tree/main/.claude/skills/grimoire-commit
Command: npx skills add https://github.com/jlissner/lissner.io --skill grimoire-commit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It generates contextual commit messages from staged changes and the active grimoire change context, ensuring commits require explicit approval and never auto-commit.

Core Features & Use Cases

  • Gather real-time change context by inspecting the git diff (staged and unstaged) and the active grimoire changes to craft meaningful, auditable messages.
  • Read configuration from .grimoire/config.yaml (commit_style) and the active change manifest to tailor the commit structure and trailers.
  • Produce conventional commit style messages with Change trailers and, when relevant, Scenarios and Decisions to keep an actionable audit trail.

Quick Start

Review the current staged changes and grimoire context, then generate and apply a conventional commit message.

Frequently Asked Questions about grimoire-commit

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

FAQPage Schema
How do I generate conventional commit messages from staged git changes?

To generate conventional commit messages from staged git changes, inspect the git diff and active grimoire context. This produces auditable messages with Change trailers and optional Scenarios or Decisions metadata, requiring explicit approval before committing.

How does grimoire context work when writing git commit messages?

Grimoire context works by reading configuration from .grimoire/config.yaml and the active change manifest to tailor commit structure and trailers. It combines staged and unstaged git diffs with this context to craft meaningful, auditable messages.

Can I include Scenarios and Decisions metadata in my conventional commits?

Yes, you can include Scenarios and Decisions metadata in conventional commits. The process generates commit messages with Change trailers and optional Grimoire metadata for Scenarios and Decisions to maintain an actionable audit trail.

What is the best way to keep an auditable git history with conventional commits?

The best way to keep an auditable git history is to generate contextual commit messages from staged changes and grimoire context. This ensures commits require explicit approval, never auto-commit, and include Change trailers for an actionable audit trail.

Do I need to configure .grimoire/config.yaml before generating commit messages?

You need to configure .grimoire/config.yaml to define the commit_style and have an active change manifest. This configuration tailors the commit structure and trailers used when generating messages from your staged git changes.

Does this git commit workflow auto-commit changes after generating the message?

No, this git commit workflow never auto-commits changes. It guides users through gathering context, validating changes, and presenting a ready-to-commit message that requires explicit approval before applying.