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,写提交信息时它会提供一个交互式提示,让你选择表情符号、范围和提交说明。
一定要用 CLI 吗?还是我可以直接手动输入表情符号代码?CLI 只是可选的便利工具,并非必需。gitmoji 只是一种命名约定,所以你完全可以在任何提交中手动输入表情符号短代码、范围和提交说明。
如何为列表提议一个新的表情符号?先开一个 issue 讨论,然后按照贡献指南提交 pull request,添加新的 gitmoji。
一条典型的 gitmoji 提交信息是什么样的?它由列表中的意图表情符号、可选的范围(提供额外上下文)和简短的说明组成,例如表情符号加上“(scope): add new feature”。
我能在自己的仓库中展示我在使用 gitmoji 吗?可以。README 提供了徽章代码,你只需粘贴到自己 README 的顶部,就能显示 Gitmoji 徽章。
Size
7.4 MB
Stars
16.8K
Age
9y
Commits · 90 Days