git-conventions

Enforce Conventional Commits syntax for Git commit messages and branch naming.

Updated Jan 10, 2025
One-click install
npx skills add https://github.com/hairihou/dotfiles --skill git-conventions-hairihou
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: git-conventions
Source: https://github.com/hairihou/dotfiles/tree/main/src/.claude/skills/git-conventions
Command: npx skills add https://github.com/hairihou/dotfiles --skill git-conventions-hairihou

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Git conventions for commits, branches, and messages to improve clarity and collaboration.

Core Features & Use Cases

  • Commit: Conventional Commits syntax for messages.
  • Branch: Conventional branch naming.
  • Guidance: Practical examples for common workflows.

Quick Start

Follow a feature workflow with a branch named feat/your-feature and a commit like feat(auth): add OAuth flow.

Frequently Asked Questions about git-conventions

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

FAQPage Schema
What are Conventional Commits and why should my team use them?

Conventional Commits is a standardized syntax for Git commit messages that improves clarity and enables automated changelog generation. It structures messages as type(scope): description—for example, feat(auth): add OAuth flow—making your Git history readable, traceable, and consistent across team projects.

How do I write a commit message following Conventional Commits?

Use the format type(scope): description. Start with a type like feat, fix, or docs, add an optional scope in parentheses, then a colon and your message. Example: fix(login): resolve session timeout bug. Keep the description clear and concise to maintain consistency across your repository.

What's the right way to name Git branches for feature development?

Follow conventional branch naming by prefixing with the commit type: feat/your-feature, fix/bug-name, or docs/update-readme. This mirrors your commit conventions and makes branch purpose immediately clear to team members reviewing pull requests or managing your workflow.

Can I enforce Conventional Commits across my team's repositories?

Yes. Conventional Commits provide a standardized format that teams can enforce through Git hooks, CI/CD checks, or code review guidelines. This ensures all contributors follow the same message and branch naming syntax, maintaining consistent Git history across your project.

Do Conventional Commits work with my existing Git workflow?

Conventional Commits respects your existing Git configuration and integrates into standard feature branch workflows without replacing your current tools. They define only message and branch syntax conventions, so adoption fits seamlessly into established development practices.

What limitations should I know about Conventional Commits?

Conventional Commits prohibit auto-generated footers to keep messages clean and human-readable. Adoption requires team discipline and tooling support; they don't solve collaboration issues on their own but standardize how your team documents changes in Git history.