commit-guidelines

Enforce gitmoji and type commit message conventions with issue references.

Updated Aug 6, 2023
One-click install
npx skills add https://github.com/k2bg-technology/k2bg-branding --skill commit-guidelines-k2bg-technology
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-guidelines
Source: https://github.com/k2bg-technology/k2bg-branding/tree/main/.claude/skills/commit-guidelines
Command: npx skills add https://github.com/k2bg-technology/k2bg-branding --skill commit-guidelines-k2bg-technology

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill enforces a consistent and informative commit message format, improving code review clarity and project history traceability.

Core Features & Use Cases

  • Standardized Format: Enforces a gitmoji + Type: #issue Subject structure.
  • Guideline Enforcement: Provides clear rules for commit types, subjects, and optional bodies/footers.
  • Use Case: Ensure all team members adhere to the same commit message conventions, making the project's version history easy to understand and navigate.

Quick Start

Use the commit-guidelines skill to format your next commit message according to project standards.

Frequently Asked Questions about commit-guidelines

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

FAQPage Schema
How do I standardize git commit messages for my project?

Standardize git commit messages by enforcing a gitmoji and type format with issue references. This structure requires an imperative mood and specific type definitions to ensure all team members follow a consistent format for version history traceability.

What is the best commit message convention for version control traceability?

An effective commit message convention for version control uses a `gitmoji + Type: #issue Subject` structure. It enforces clear rules for commit types, subjects written in imperative mood, and optional body and footer structures to maximize project history traceability.

How do I format a git commit message with a gitmoji and issue reference?

Format a git commit message by combining a gitmoji, a specific commit type, and an issue reference in the subject line. You must use imperative mood for the subject, and can add optional body and footer structures to provide additional context for code review.

Can I use custom commit types and bodies in my git commit guidelines?

Yes, you can use custom commit types and optional bodies in your git commit guidelines. The convention applies specific type definitions and allows optional body and footer structures to ensure commit message creation and review processes remain clear and consistent within the repository.

Why does my commit message convention require imperative mood?

Your commit message convention requires imperative mood to maintain clarity and consistency across the repository. Writing subjects in imperative mood standardizes the action description, making the project's version history easier to understand and navigate during code review.

When do I need to include a footer in my git commit message?

Include a footer in your git commit message when you need to add extra metadata like issue references not covered in the subject. Footers are optional structures in the commit guidelines that provide additional context without cluttering the main subject line.