Agent skill

git-conventional-commits

Professional git commit workflow with Conventional Commits format. Enforces commit type categorization (feat, fix, docs, style, refactor, perf, test, build, ci, chore), validates messages against the 7 rules of great commits, previews before committing, and supports multiple languages. Use when you need to create high-quality, traceable git commits.

Stars 2
Forks 1

Install this agent skill to your Project

npx add-skill https://github.com/Eva813/vue3-skills/tree/main/.agents/skills/git-conventional-commits

Metadata

Additional technical details for this skill

author
User
version
1.0.0

SKILL.md

Git Conventional Commits Skill

Professional git commit workflow that enforces best practices and conventions.

Features

  • Conventional Commits Format: Categorize commits by type (feat, fix, docs, style, refactor, perf, test, build, ci, chore)
  • Message Validation: Adheres to the 7 rules of great git commits:
    • Separate subject from body with a blank line
    • Limit the subject line to 50 characters
    • Capitalize the subject line
    • Do not end the subject line with a period
    • Use the imperative mood in the subject line
    • Wrap the body at 72 characters
    • Use the body to explain what and why vs. how
  • Auto-Detection: Intelligently detects commit type based on file changes
  • Preview & Confirmation: Shows formatted commit message before committing
  • Multi-Language Support: English and Traditional Chinese (繁體中文)

Commit Types

Type Description
feat A new feature
fix A bug fix
docs Documentation only changes
style Formatting, white-space, or semi-colon changes (no code meaning change)
refactor A code change that neither fixes a bug nor adds a feature
perf Code that improves performance
test Adding missing tests or correcting existing ones
build Changes to build-related components or dependencies
ci Changes to the CI/CD setup
chore Routine tasks or maintenance

When to Use

Reference this skill when you need to:

  • Create a git commit with proper conventional format
  • Ensure commit messages follow best practices
  • Auto-detect the type of change being committed
  • Preview and confirm commit messages before finalizing
  • Support multiple commit message languages

Example Usage

bash
# Invoke the skill when you have staged or unstaged changes
# The skill will:

# 1. Analyze git status and changes
#    - Shows what files are modified/added/deleted
#    - Automatically stages appropriate files

# 2. Auto-detect commit type based on changes
#    - feat: New features (new files, new APIs)
#    - fix: Bug fixes (fixes existing functionality)
#    - docs: Documentation changes only
#    - style: Formatting changes (no logic change)
#    - refactor: Code restructuring (no logic change)
#    - perf: Performance optimizations
#    - test: Test additions/fixes
#    - build: Build system/dependency changes
#    - ci: CI/CD configuration changes
#    - chore: Maintenance tasks

# 3. Generate commit message
#    - Subject line: "{type}: {description}" (max 50 chars)
#    - Body (optional): Explains what and why
#    - Follows all 7 rules of great commit messages

# 4. **DISPLAY PREVIEW** - Saves to session temporary directory
#    Location: ~/.copilot/session-state/{session_id}/commit_preview.txt
#    
#    Content (plain text, fully readable):
#    ════════════════════════════════════════════════════════════
#    feat: Add user authentication
#    
#    Implement JWT-based auth system with secure token handling
#    and automatic refresh logic. Prevents users from being logged
#    out unexpectedly during long sessions.
#    
#    ────────────────────────────────────────────────────────────
#    Files: 3 changed | +145 insertions | -8 deletions
#    ════════════════════════════════════════════════════════════
#    
#    Benefits of using session temp directory:
#    - Does NOT pollute your project directory
#    - Will NOT be tracked by git
#    - Automatically cleaned up when session ends

# 5. **REQUEST USER CONFIRMATION**
#    - User is asked: "Please review the commit message in
#      ~/.copilot/session-state/{session_id}/commit_preview.txt
#      Do you want to proceed?"
#    - Mandatory: User must explicitly approve
#    - Options: ✅ Yes, confirm and commit | ❌ No, cancel commit

# 6. **EXECUTE COMMIT** (Only if confirmed)
#    If user approves:
#    git commit -m "feat: Add user authentication" \
#               -m "Implement JWT-based auth system..."
#    
#    If user declines:
#    Commit cancelled by user. (No changes made)

Important: Preview & Confirmation

This skill ALWAYS shows a preview and waits for explicit user confirmation before committing.

This prevents accidental commits and ensures quality control. The preview step is mandatory and cannot be skipped.

Preview File Location: ~/.copilot/session-state/{session_id}/commit_preview.txt

  • Automatically cleaned up when session ends
  • Not tracked by git
  • Easy to find in your session folder

Configuration

  • Default Language: English
  • Commit Body: Optional (automatically included when explaining "why" for complex changes)
  • Message Validation: All messages validated against 7 rules before committing
  • Preview Storage: Session temporary directory (not project directory)

Important: Preview & Confirmation

This skill ALWAYS shows a preview and waits for explicit user confirmation before committing.

This prevents accidental commits and ensures quality control. The preview step is mandatory and cannot be skipped.

Configuration

  • Default Language: English
  • Commit Body: Optional (automatically included when explaining "why" for complex changes)
  • Message Validation: All messages validated against 7 rules before committing

Expand your agent's capabilities with these related and highly-rated skills.

Eva813/vue3-skills

vercel-composition-patterns

React composition patterns that scale. Use when refactoring components with boolean prop proliferation, building flexible component libraries, or designing reusable APIs. Triggers on tasks involving compound components, render props, context providers, or component architecture. Includes React 19 API changes.

2 1
Explore
Eva813/vue3-skills

vercel-react-best-practices

React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.

2 1
Explore
Eva813/vue3-skills

vercel-react-native-skills

React Native and Expo best practices for building performant mobile apps. Use when building React Native components, optimizing list performance, implementing animations, or working with native modules. Triggers on tasks involving React Native, Expo, mobile performance, or native platform APIs.

2 1
Explore
Eva813/vue3-skills

vue3-best-practices

Vue 3 performance optimization and best practices guidelines for modern frontend applications. This skill should be used when writing, reviewing, or refactoring Vue 3 code to ensure optimal performance patterns, proper Composition API usage, and modern development practices. Triggers on tasks involving Vue 3 components, Composition API, reactivity, state management, or performance optimization.

2 1
Explore
Eva813/vue3-skills

web-design-guidelines

Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "check accessibility", "audit design", "review UX", or "check my site against best practices".

2 1
Explore
Eva813/vue3-skills

frontend-design

Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.

2 1
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results