commit-message-storyteller

Generate Conventional Commits messages from git diffs and staged changes.

Updated Aug 26, 2024
One-click install
npx skills add https://github.com/FabienDehopre/my-netatmo-24 --skill commit-message-storyteller-fabiendehopre
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-message-storyteller
Source: https://github.com/FabienDehopre/my-netatmo-24/tree/main/.agents/skills/commit-message-storyteller
Command: npx skills add https://github.com/FabienDehopre/my-netatmo-24 --skill commit-message-storyteller-fabiendehopre

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill solves the problem of writing vague commit messages by transforming raw code changes into clear explanations of intent, context, and impact.

Core Features & Use Cases

  • Diff Analysis: Interprets git diffs, staged changes, and change descriptions to understand what changed and why.
  • Conventional Commit Generation: Creates structured commit messages with appropriate types, scopes, bodies, and footers.
  • Commit History Improvement: Helps developers create maintainable project histories and prepare clearer pull requests.

Quick Start

Use the commit-message-storyteller skill to generate a Conventional Commit message from my staged git diff.

Frequently Asked Questions about commit-message-storyteller

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

FAQPage Schema
How do I generate conventional commit messages from git diffs automatically?

Generating conventional commit messages from git diffs involves analyzing staged file modifications and their development intent to produce structured messages with appropriate types, scopes, and bodies.

What is the best way to write meaningful commit messages for pull requests?

Writing meaningful commit messages for pull requests requires interpreting code changes to explain the context and impact, transforming raw diffs into narrative explanations of why updates were made.

How does contextual analysis improve git commit history?

Contextual analysis improves git commit history by interpreting the intent behind code changes rather than just listing modifications, creating maintainable project narratives and clearer pull request descriptions.

Can I use staged git files to create structured commit messages with types and scopes?

Yes, you can use staged git files to create structured commit messages by analyzing the modifications and applying conventional commits formatting with appropriate types, scopes, bodies, and footers.

Do I need to provide a change description for diff analysis to work?

Providing a change description supports diff analysis by supplying contextual intent alongside raw git modifications, allowing for more accurate narrative explanations of why code updates were made.