ce-commit

Generate conventional git commit messages from the current working tree.

Updated Sep 25, 2024
One-click install
npx skills add https://github.com/kwam1na/athena --skill ce-commit-kwam1na
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ce-commit
Source: https://github.com/kwam1na/athena/tree/main/.agents/skills/ce-commit
Command: npx skills add https://github.com/kwam1na/athena --skill ce-commit-kwam1na

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps developers produce clear, well-structured git commit messages that reflect changes and adhere to repository conventions or conventional commits when possible.

Core Features & Use Cases

  • Generate concise subject lines that describe the change from the working tree.
  • Automatically include an optional body with rationale, if the change requires more details.
  • Suggest branch strategy and grouping of related changes into logical commits to keep history clean.

Quick Start

Create a well-formed commit message from the current changes.

Frequently Asked Questions about ce-commit

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

FAQPage Schema
How do I generate conventional git commit messages from my working tree changes?

Git branch strategy guidance is provided by suggesting how to group multiple logical changes into separate commits. This keeps your repository history clean by ensuring each commit reflects a single, coherent modification set rather than mixing unrelated updates.

Can I group multiple file changes into a single logical commit?

Yes, multiple file changes are automatically grouped into logical commit sets based on the repository context. This ensures your commit history remains clean and each message accurately reflects a cohesive logical change across the working tree.

Does this workflow require any specific repository conventions to function?

You need the current git context and repository conventions to generate well-formed commit messages. The workflow requires only this git context to enforce message structure, automatically including a subject and optional body for your changes.

What's the best way to structure a commit message for a complex change set?

The best way to structure a commit message for a complex change set is to enforce conventional commit patterns with a concise subject line and an optional body. This provides the necessary rationale and keeps grouped logical changes clearly separated in history.

When should I not use automated conventional commit generation?

Automated conventional commit generation should be avoided when your working tree lacks clear git context or when changes are too ambiguous to group logically. It requires identifiable repository conventions and distinct logical change sets to enforce message structure accurately.