Skip to content

glazrtom/conventional-gitmoji-config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Conventional gitmoji — configuration for Gitmoji intellij Commit Button plugin

This repository contains a small configuration and translations for using a "conventional gitmoji" commit style with the Gitmoji Plus Commit Button IntelliJ plugin.

Specification

This configuration implements the conventional gitmoji concept created by Ackee.

With this configuration, it limits the available gitmojis to a small, well-defined set that maps to Conventional Commit intent (feat, fix, docs, etc.). Use the emoji that best communicates why the change was made.

Allowed emojis and their intent

  • ✨ feat — new feature
  • 🐛 fix — bug fix
  • 👷 build — changes that affect the build system or external dependencies
  • 💚 ci — changes to CI configuration and scripts
  • 📝 docs — documentation-only changes
  • ♻️ refactor — code changes that neither fix bugs nor add features
  • ⚡️ perf — performance improvements
  • ✅ test — adding or correcting tests
  • ⏪️ revert — reverts a previous commit

Repository contents

  • gitmojis.json — plugin configuration listing available gitmojis and their metadata.
  • localizations/ — translations for the gitmoji labels (en_US, fr_FR, pt_BR, ru_RU, zh_CN).

Using this config with the IntelliJ plugin

Install the Gitmoji Plus Commit Button plugin and point it at this configuration file.

Set the gitmojis url to:

https://raw.githubusercontent.com/glazrtom/conventional-gitmoji-config/refs/heads/master/gitmojis.json

and the localization url to:

https://raw.githubusercontent.com/glazrtom/conventional-gitmoji-config/refs/heads/master/localizations/gitmojis-{locale}.yaml

The plugin will use the gitmojis.json and the localization files to present a constrained, conventional set of emojis when creating commits.

settings.png

License and attribution

This configuration is implementation of the conventional gitmoji concept created by Ackee. It is an configuration for use with the Gitmoji Plus Commit Button plugin.

Contributions

Contributions and localization updates are welcome — open a PR or issue with suggested changes.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published