aif-commit

Generate conventional commit messages from staged Git changes.

Updated Mar 23, 2024
One-click install
npx skills add https://github.com/Ard2p/sk-bar-site --skill aif-commit-ard2p
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: aif-commit
Source: https://github.com/Ard2p/sk-bar-site/tree/main/.cursor/skills/aif-commit
Command: npx skills add https://github.com/Ard2p/sk-bar-site --skill aif-commit-ard2p

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of conventional commit messages from staged changes, ensuring consistency with the Conventional Commits guidelines and project conventions.

Core Features & Use Cases

  • Generate commit messages that reflect the nature of changes (feat, fix, docs, chore, etc.) and include an appropriate scope based on file paths.
  • Enforce project-specific rules, architecture, and roadmap contexts, and respect skill-context overrides for precise workflow alignment.
  • Validate and present suggested messages before committing, with options to adjust or split changes as needed.

Quick Start

Provide a concise conventional commit message for the currently staged changes.

Frequently Asked Questions about aif-commit

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

FAQPage Schema
How do I auto-create conventional commit messages from staged git changes?

You can automate conventional commit generation by interpreting staged git diffs and applying project rules to produce scope-aware messages. The system validates output before presenting a commit proposal for your review.

Can I enforce project-specific rules and scopes when generating commit messages?

Yes, generating commit messages can enforce project-specific rules by applying architecture and roadmap contexts. It respects skill-context overrides to ensure precise workflow alignment and produces scope-aware conventional messages based on file paths.

Does conventional commit automation work with multi-project git repositories?

Conventional commit automation works with multi-project environments by interpreting staged diffs across the repository. It applies architecture and project rules to generate appropriate commit proposals tailored to each project's context.

How do I validate and adjust suggested commit messages before committing?

To validate suggested commit messages, the system presents a proposal for your review before committing. You can adjust the proposed message or split changes as needed to ensure the conventional commit accurately reflects your staged changes.

What's the best way to maintain consistency with Conventional Commits guidelines across a team?

The best way to maintain Conventional Commits consistency is to automate message creation from staged changes. By interpreting diffs and applying project rules, the system generates feat, fix, docs, or chore types with appropriate scopes automatically.

Why does my auto-generated commit message include a specific scope?

Auto-generated commit messages include specific scopes by interpreting staged file paths and applying architecture rules. This scope-aware approach ensures the conventional commit message accurately reflects which project component was modified.