English

关于

Gitmoji 尝试标准化和解释 emoji 在GitHub 提交信息中的使用。

在提交信息中使用emoji可以让识别提交的目的或者意图变得简单，只需要看一眼使用的 emoji 就好了。因为存在大量的不同的 emoji 所以创建一个能够让使用 emoji 更简单的指南就很有必要了。

使用 gitmoji-cli

如果要从命令行使用 gitmojis，请安装 gitmoji-cli。这是一个在写提交信息时使用的交互式 gitmoji 客户端。

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>

贡献到 gitmoji

要给 gitmoji 做贡献那真是小菜一碟，阅读 贡献指引。你可以在issues 部分讨论 emoji。要添加新的 emoji 到清单只需创建一个 issue 并且发一个拉取请求即可，参考 如何发一个拉取请求来添加 gitmoji.

许可

代码允许在 MIT 许可下使用。