eliorc / gitmoji

An emoji guide for your commit messages. 😜

About

Gitmoji is an initiative to standardize and explain the use of emojis on GitHub commit messages.

Using emojis on commit messages provides an easy way of identifying the purpose or intention of a commit with only looking at the emojis used. As there are a lot of different emojis I found the need of creating a guide that can help to use emojis easier.

The gitmojis are published on the following package in order to be used as a dependency 📦.

Using gitmoji-cli

To use gitmojis from your command line install gitmoji-cli. A gitmoji interactive client for using emojis on commit messages.

npm i -g gitmoji-cli

Related tools

• gitmoji-changelog: A changelog generator for gitmoji.
• gitmemoji: A game to learn gitmojis.
• gitmoji-browser-extension: The Gitmoji extension to easily search and copy gitmojis 😜
• gitmoji-vscode: A VSCode extension for your git commit messages 😄
• gitmoji-intellij-plugin: A Jetbrains suite plugin to easily add gitmoji when committing in the IDE
• gitmoji-sublimetext: A Sublime Text plugin to add emojis in git commit messages 😄
• gitimoji: A Gitmoji App for macOS

Contributing to gitmoji

Contributing to gitmoji is a piece of 🍰, read the contributing guidelines. You can discuss emojis using the issues section. To add a new emoji to the list create an issue and send a pull request, see how to send a pull request and add a gitmoji.

Spread the word

Are you using Gitmoji on your project? Set the Gitmoji badge on top of your readme using this code:

<a href="https://gitmoji.carloscuesta.me">
  <img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square" alt="Gitmoji">
</a>

License

The code is available under the MIT license.