git-commit

Automates git commits following the Conventional Commits specification from code diffs.

7|3|Updated Dec 24, 2023
One-click install
npx skills add https://github.com/Pony-Unicorn/react-template --skill git-commit-pony-unicorn
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-commit
Source: https://github.com/Pony-Unicorn/react-template/tree/main/.agents/skills/git-commit
Command: npx skills add https://github.com/Pony-Unicorn/react-template --skill git-commit-pony-unicorn

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of standardized, semantic git commits, ensuring consistency and clarity in your project's version history.

Core Features & Use Cases

  • Conventional Commits: Adheres to the Conventional Commits specification for structured commit messages.
  • Intelligent Staging: Analyzes diffs to suggest or automatically stage relevant files.
  • Message Generation: Generates commit messages based on code changes, including type, scope, and description.
  • Use Case: After making several related changes to a feature, use this Skill to generate a feat commit with the correct scope and a concise description, ensuring your commit history is clean and informative.

Quick Start

Use the git-commit skill to create a commit with the message "feat: add user authentication module".

Frequently Asked Questions about git-commit

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

FAQPage Schema
How do I generate conventional commits automatically from code diffs?

To generate conventional commits automatically, this Skill analyzes your code diffs to determine the commit type, scope, and description, ensuring your version history adheres to standardized semantic practices.

What is the best way to stage files for logical grouping before a git commit?

Intelligent staging analyzes your code changes to suggest or automatically stage relevant files into logical groups, creating clean and informative commits without manual file selection.

Can I override a generated conventional commit message interactively?

Yes, you can interactively override generated commit messages, allowing you to manually adjust the type, scope, or description while maintaining adherence to conventional commit formatting.

How do I ensure my git commit messages follow the conventional commits specification?

By automating commit creation based on code diffs, the tool formats messages into structured types like 'feat' or 'fix', ensuring strict adherence to the conventional commits specification.

Do I need to manually specify the scope when creating a feature commit?

No, the tool automatically determines the appropriate scope and description by analyzing your code changes, though you retain the ability to interactively override the suggested commit message.