gitmoji README

The project's README from github.com/carloscuesta/gitmoji. As one markdown file: README.md.

gitmoji

Build Status Gitmoji

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

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>

Contributing to gitmoji

Contributing to gitmoji is a piece of :cake:, 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.

gitmoji (carloscuesta/gitmoji)

Searching Database…

16.8K ·GitHub
Gitmoji
What is this?Gitmoji is an initiative to standardize using emojis in GitHub commit messages, so you can tell a commit's purpose just by looking at the emoji used.
Is this a ready-to-run tool, or just a list of emojis?This repo is the gitmoji specification/list, published as a package so other tools can depend on it. The actual command-line experience comes from the separate gitmoji-cli project.
How do I actually use gitmoji when committing?Install gitmoji-cli, which gives you an interactive prompt for picking an emoji, scope, and message when writing a commit.
Do I need the CLI, or can I just type the emoji codes manually?The CLI is optional convenience, not a requirement: since gitmoji is just a naming convention, you can manually type an emoji shortcode plus scope and message in any commit.
How do I propose a new emoji for the list?Open an issue to discuss it, then follow the contributing guidelines to send a pull request adding the new gitmoji.
What does a typical gitmoji commit message look like?It combines an intention emoji from the list, an optional scope for extra context, and a short message, e.g. an emoji plus '(scope): add new feature'.
Can I show on my own repo that I use gitmoji?Yes, the README provides badge code you can paste at the top of your own README to display a Gitmoji badge.
What are similar projects?epiq, degit, emoji-cheat-sheet, cz-cli, diffle, commitlint, git-bug, obsidian-git
Which topics is it in?emoji, version-control, github, git, guide, list, productivity, command-line-tool, npm, nodejs, typescript, cli
Creator
carloscuesta
Size
7.4 MB
Stars
16.8K
Updated
CommitOct 15Releasev3.15.0Mar 12
Age
9y
Commits · 90 Days