# Gitmoji

![time tracker](https://wakatime.com/badge/github/alanJaouen/sublimeGitMoji.svg)
![flake8](https://github.com/alanJaouen/sublimeGitMoji/workflows/flake8/badge.svg?branch=master)


> Inspired by <a href="https://gitmoji.carloscuesta.me"><img src="https://cloud.githubusercontent.com/assets/7629661/20073135/4e3db2c2-a52b-11e6-85e1-661a8212045a.gif" width="80" alt="gitmoji" style="vertical-align: middle;"></a>

This extension helps you to add emoji on your 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.

## Usage

Use ``ctrl+shift+P`` to open command palette.

Select ``Gitmoji: Insert emoji`` or ``Gitmoji: Insert shortcode`` in command palette.

![screenshot menu](https://i.ibb.co/1ngYZ7f/Screenshot-7.png)

Then type your use case and select the right emoji.

![screenshot menu 2](https://i.ibb.co/VwH7LQg/image.png)

## Customization

You can add your own emojis and description to fit your needs by adding them in the settings file.

use the menu preferences -> Package Settings -> GitMoji -> Settings
or type ``Preferences: Gitmoji Settings`` in the command palette.

## Installation

Use ``ctrl+shift+P`` to open command palette.

Select ``Package Control: Install Package`` in command palette.

Select ``Gitmoji`` in the list of packages.