Skip to content

An emoji guide for your commit messages. ๐Ÿ˜œ

License

stars-one/gitmoji

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

gitmoji

Build Status Gitmoji

About

Gitmojiไธญๆ–‡ is an initiative to standardize and explain the use of emojis on GitHub commit messages.

้ƒจ็ฝฒๅœฐๅ€๏ผšhttps://vercel.com/stars-one1/gitmoji

้ƒจ็ฝฒ: 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 ๐Ÿ“ฆ.

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

Example of usage

In case you need some ideas to integrate gitmoji in your project, here's a practical way to use it:

<intention> [scope?][:?] <message>
  • intention: An emoji from the list.
  • scope: An optional string that adds contextual information for the scope of the change.
  • message: A brief explanation of the change.

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.dev">
  <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.

About

An emoji guide for your commit messages. ๐Ÿ˜œ

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 81.7%
  • CSS 18.1%
  • Shell 0.2%