Gitmoji is an emoji guide for GitHub commit messages. Aims to be a standarization cheatsheet - guide for using emojis on GitHub's 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.
This project is Open Source, that means everyone can participate, suggesting, discussing and adding new emojis. Take a look at the contributing section and the guidelines for contributing.
Using gitmoji with gitmoji-cli
An easy solution for using gitmoji from your command line, is to install gitmoji-cli. A gitmoji interactive client for using emojis on commit messages.
$ npm i -g gitmoji-cli
Contributing to gitmoji
Contributing to gitmoji it's a piece of cake 🍰! This project it's a static website built with Pug, SCSS, Gulp and ES6. All the gitmojis displayed are rendered from a JSON file. Before submitting any pull request, please follow the next steps:
- Create an issue filling the template.
- After discussing the idea, feature or suggestion, fork gitmoji
- Create a new branch with the feature name. (Eg: add-emoji-deploy, fix-website-header)
- Make your changes and send a pull request .