git-commit-prompt

Generate prompts for atomic Git commits with conventional messages.

14|Updated May 28, 2024
One-click install
npx skills add https://github.com/cameronraysmith/vanixiets --skill git-commit-prompt
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-commit-prompt
Source: https://github.com/cameronraysmith/vanixiets/tree/main/modules/home/ai/skills/src/core/git-commit-prompt
Command: npx skills add https://github.com/cameronraysmith/vanixiets --skill git-commit-prompt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users generate optimal prompts for AI agents to create atomic Git commits with conventional commit messages, ensuring cleaner and more organized version control history.

Core Features & Use Cases

  • Atomic Commits: Guides the AI to commit changes one file at a time.
  • Conventional Commits: Encourages the use of short, standardized commit messages.
  • Contextual Prompts: Includes relevant context like worktree and virtual environment in the prompt.
  • Use Case: When you have made several unrelated changes and want to commit them individually with clear, concise messages, use this skill to craft the perfect prompt for your AI assistant.

Quick Start

Use the git-commit-prompt skill to generate a prompt for atomically committing changes with conventional messages, including the current worktree and virtual environment context.

Frequently Asked Questions about git-commit-prompt

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

FAQPage Schema
How do I generate conventional commit messages for multiple unrelated file changes?

Atomic commits involve saving changes one file at a time with standardized conventional commit messages. This approach is needed when you have made several unrelated changes and want to commit them individually to maintain a clean, organized, and easily trackable Git history.

How do I prompt an AI agent to commit changes one file at a time?

You can prompt an AI agent to commit changes atomically by using this skill to generate a contextual prompt that includes your current worktree and virtual environment. The generated prompt instructs the agent to commit files individually using conventional commit formats.

Does this git commit prompt generator include worktree and virtual environment context?

Yes, the generated git commit prompts explicitly include relevant contextual information such as the current worktree and virtual environment. This ensures the AI agent has the necessary environmental context to create precise and descriptive conventional commit messages.

What is the best way to organize my Git history when using an AI coding assistant?

The best way to organize your Git history with an AI coding assistant is to enforce atomic commits using conventional commit messages. This skill generates the necessary prompts to ensure the agent commits changes one file at a time, keeping your version control structured and clean.

Can I use this skill to clean up a messy worktree with mixed unrelated changes?

Yes, you can use this skill to clean up a messy worktree by generating prompts that direct an AI agent to separate mixed unrelated changes into atomic, one-file-at-a-time commits. It facilitates precise conventional commit messages for each isolated change.