Skip to content

Instantly share code, notes, and snippets.

@berkus
Last active January 20, 2024 16:11
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save berkus/5ce2cdf5dd74909bcd4faf6cb7d0ae18 to your computer and use it in GitHub Desktop.
Save berkus/5ce2cdf5dd74909bcd4faf6cb7d0ae18 to your computer and use it in GitHub Desktop.
Conventional Commits with Emoji

Conventional Commits with Emoji

Based on https://github.com/ellerbrock/conventional-commit-types-emoji for preview and on https://github.com/pvdlg/conventional-commit-types for the actial emoji images

🚨 There is a commit-emoji hook now to insert emoji automatically based on prefix, so you can just install it and use regular conventional commits (even using a tool like koji). 🚨


feat(xxx): ✨ Features your commit message

fix(xxx): πŸ› Bug Fixes

docs(xxx): πŸ“š Documentation

style: πŸ’Ž Styles

refactor: πŸ“¦ Code Refactoring

perf(xxx): πŸš€ Performance Improvements

test(xxx): 🚨 Tests

build(xxx): πŸ›  Build

ci(xxx): βš™οΈ Continuous Integration

chore(xxx): ♻️ Chores

revert(xxx): πŸ—‘ Reverts

deprecated(xxx): ⛔️ Deprecates feature

removed(xxx): ❌ Removes feature

security(xxx): πŸ” Security fixes

merge: ⛓️ Merge branch - ?

Special emoji for breaking changes: πŸ’”

Mapped values

(replaces entire commit message)

initial -> feat: πŸŽ‰ Initial commit

deps -> fix: ⏫ Update dependencies

peerdeps -> fix: ⬆️ Update peer dependencies

devdeps -> chore: πŸ”Ό Update development dependencies

metadata -> fix: πŸ“¦ Update metadata (Cargo.toml)

typos -> chore: ♻️ Fix typos

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment