mcpField
G
gitmoji-commits

gitmoji-commits

github.com/sthbryanDevelopment075 installsUpdated 32w ago
Repository

About gitmoji-commits

gitmoji-commits is a workflow skill for developers preparing Git commits. It guides change review, commit splitting, emoji selection, staging, and concise Conventional Commit messages.

Key features

  1. 01Inspect changes and group by intent
  2. 02Plan separate commit boundaries
  3. 03Select emojis for commit types
  4. 04Draft scoped Conventional Commit messages
  5. 05Stage changes and run safety checks
  6. 06Use the gitmoji selector script

Use cases

  1. 01Preparing commits from a mixed working tree
  2. 02Keeping unrelated changes in separate commits
  3. 03Choosing an emoji for a change type

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/sthbryan/gitmoji-skill --skill gitmoji-commits

After installing, type/gitmoji-commitsin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

AGENTS.md
LICENSE
README.md
.gitignore
evals/
evals.json
references/
gitmoji-guide.md
scripts/
gitmoji_selector.sh
test.sh

Details

From the project README

Gitmoji Commits

Create clean, intentional commits with the right emoji and scope.

Workflow (use in order)

  1. Inspect working tree

    • Run: git status --short and git diff --stat
    • Identify file groups by intent (feature, fix, docs, tests, config).

  2. Plan commit boundaries

    • Split unrelated work into separate commits.
    • Use git add -p for mixed files.

  3. Choose emoji (core-first)

    • Preferred: bash scripts/gitmoji_selector.sh --emoji-only "<change summary>"
    • If unsure/rare case: consult references/gitmoji-guide.md.

  4. Draft commit message

    • Format: emoji type(scope): subject
    • Keep subject imperative and concise (<= 50 chars).

  5. Stage only intended changes

    • Run: git add <file> or git add -p
    • Re-check with: git diff --cached --stat.

  6. Safety check before commit

    • Ensure no secrets, debug logs, or accidental churn.
    • Ensure commit content matches the message.

  7. Commit and repeat

    • Run: git commit -m "<message>"
    • Repeat until working tree is clean.

Commit Format

✨ feat(auth): Add two-factor login

Optional body:

✨ feat(auth): Add two-factor login

- Add TOTP enrollment and verification
- Update auth service and user model

Closes #123

Type Guide

Use Conventional Commit types: feat, fix, refactor, docs, test, perf, style, chore, ci, build

Common scopes: auth, api, ui, db, ci, deps

Core Emoji Map (auto-detected)

TypeEmojiKeywords
Feature✨add, new, implement
Bug fix🐛fix, bug, error
Simple fix🩹typo, quick, one-liner
Documentation📝docs, readme, changelog
Tests🧪test, spec, integration
Refactor♻️refactor, extract, restructure
Performance⚡optimize, perf, cache
UI/Styles💄css, style, ui, theme
Dependencies📦npm, dependency, package
Security🔐security, cve, xss
Config⚙️ / 🔧config, setup, settings
Remove🗑️remove, delete, deprecate
Major🔨rewrite, redesign, architect
Deploy🚀deploy, release, ship
SEO🔍seo, metadata
i18n🗣️translate, locale
Linter🚨eslint, prettier
Automation🔄github actions, workflow
Test pass✅tests passing, green build
Upgrade deps⬆️upgrade, bump
Downgrade deps⬇️downgrade
Types/Tag🏷️type definitions, version tags
Copy/Text💬copy, strings, text
Comments/Notes💡comment, todo, note
Mocks🎭mock, stub

Special Cases (highest priority)

EmojiWhen
⏪Revert commits
🔀Merge commits
🚑Hotfix
🚧WIP

Helper Script

# Emoji only (fast)
bash scripts/gitmoji_selector.sh --emoji-only "fix critical bug"

# JSON suggestion
bash scripts/gitmoji_selector.sh "update api docs"

# Full Conventional Commit
bash scripts/gitmoji_selector.sh --conventional feat auth "Add login"

Comments

Markdown supported