commit-conventions

Apply universal git commit conventions for consistent commit messages.

10|2|Updated Oct 3, 2020

Search Tags:#git #commit #best-practices #version-control #commit-message #co-authored-by

Ready to run

npx skills add https://github.com/Gelio/dotfiles --skill commit-conventions-gelio

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit-conventions
Source: https://github.com/Gelio/dotfiles/tree/main/universal/claude/skills/commit-conventions
Command: npx skills add https://github.com/Gelio/dotfiles --skill commit-conventions-gelio

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Commit messages are inconsistently written, making it hard to understand project history, review changes effectively, and enforce traceability across repositories.

Core Features & Use Cases

Defines a standard commit message format including type, scope, subject, and body.
Guides proper staging, the Write-tool workflow, and post-commit verification to improve reliability and traceability.
Provides examples and best practices for formatting, including co-authored-by lines and body structure.

Quick Start

Use the universal commit conventions whenever creating a git commit to ensure a well-structured, explainable history.

Frequently Asked Questions about commit-conventions

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

FAQPage Schema

What is the standard format for a git commit message?▼

A standard git commit message includes a defined type, scope, subject, and body. Applying universal commit conventions ensures consistent formatting and a reliable, explainable project history across repositories.

How do I write reliable git commits in a sandbox environment?▼

To write reliable git commits in a sandbox, use the Write-tool and git-commit pattern, enable GPG signing, and perform post-commit verification. These commit conventions ensure traceability even within restricted environments.

When should I use co-authored-by lines in a commit message?▼

Use co-authored-by lines in a commit message to attribute work to multiple contributors. Universal commit conventions provide best practices for formatting these attribution lines within the commit body.

Does this approach to version control support YAML frontmatter?▼

Yes, this version control approach specifies YAML frontmatter with name and description fields. It also supports optional scripts, references, and assets to extend commit conventions and behavior.

What is the best way to maintain staging discipline for git commits?▼

The best way to maintain staging discipline is following structured commit conventions that guide proper staging and the Write-tool workflow. This improves change review effectiveness and traceability across projects.

Why are inconsistent commit messages a problem for project history?▼

Inconsistent commit messages make it hard to understand project history and review changes effectively. Universal commit conventions solve this by enforcing a standard format for reliable, high-quality version control.