gitmoji Documentation

Technical Documentation: carloscuesta/gitmoji

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

About Copy Chapter

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](https://github.com/carloscuesta/gitmoji-cli) Copy Chapter

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

npm i gitmoji-cli

Example of usage Copy Chapter

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 Copy Chapter

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 Copy Chapter

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 Copy Chapter

The code is available under the MIT license.

Overview (`packages/gitmojis/README.md`) Copy Section

About Copy Chapter

The emojis from the gitmoji convention bundled into a node module.

Install Copy Chapter

npm i gitmojis

Usage Copy Chapter

import { gitmojis } from 'gitmojis'

console.log(gitmojis)

/*
[
  {
    emoji: '🎨',
    entity: '🎨',
    code: ':art:',
    description: 'Improve structure / format of the code.',
    name: 'art',
    semver: null
  },
  {
    emoji: '⚡️',
    entity: '⚡',
    code: ':zap:',
    description: 'Improve performance.',
    name: 'zap',
    semver: null
  },
  ...
]
*/

API Copy Chapter

Alternatively you can also consume this as through HTTP using the API:

curl https://gitmoji.dev/api/gitmojis

Spread the word Copy Chapter

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>

--- METRICS ---

• Files Extracted: 2
• Estimated Token Budget: ~1099 tokens
• Canonical Reference: https://codewiki.google/github.com/carloscuesta/gitmoji