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 — это инициатива по стандартизации использования эмодзи в сообщениях коммитов GitHub, чтобы по эмодзи можно было понять назначение коммита, не читая его текст.
Это готовый инструмент или просто список эмодзи?Этот репозиторий содержит спецификацию и список gitmoji, опубликованный как пакет, чтобы другие инструменты могли от него зависеть. Сам интерфейс командной строки предоставляет отдельный проект gitmoji-cli.
Как на самом деле пользоваться gitmoji при коммите?Установите gitmoji-cli — он даёт интерактивное приглашение, где при создании коммита можно выбрать эмодзи, область (scope) и текст сообщения.
Нужен ли CLI или можно просто вводить коды эмодзи вручную?CLI — необязательное удобство, а не требование: поскольку gitmoji — это просто соглашение об именовании, в любом коммите можно вручную написать код эмодзи, область и сообщение.
Как предложить новый эмодзи для списка?Откройте issue, чтобы обсудить идею, затем следуйте руководству по участию в проекте и отправьте pull request с добавлением нового gitmoji.
Как выглядит типичное сообщение коммита с gitmoji?Оно сочетает эмодзи-намерение из списка, необязательную область (scope) для дополнительного контекста и короткое сообщение, например эмодзи и '(scope): add new feature'.
Можно ли показать в моём репозитории, что я использую gitmoji?Да, в README есть код бейджа, который можно вставить в начало своего README, чтобы отобразить бейдж Gitmoji.
Size
7.4 MB
Stars
16.8K
Age
9y
Commits · 90 Days