关于
Gitmoji 是一项旨在标准化和解释在GitHub提交消息中使用表情符号的倡议。
在提交消息中使用表情符号提供了一种简单的方式来仅通过查看使用的表情符号就能识别提交的目的或意图。由于有很多不同的表情符号,我发现有必要创建一个指南,帮助更轻松地使用表情符号。
这些gitmoji已发布在以下包中,以便作为依赖项使用 📦。
使用 gitmoji-cli
要从命令行使用gitmoji,请安装 gitmoji-cli。这是一个用于在提交消息中使用表情符号的gitmoji交互式客户端。
npm i -g gitmoji-cli
使用示例
如果你需要一些将gitmoji集成到项目中的想法,这里有一种实用的方式:
<意图> [范围?][:?] <消息>
意图
:列表中的一个表情符号。范围
:一个可选的字符串,为变更的范围添加上下文信息。消息
:对变更的简短解释。
为gitmoji贡献
为gitmoji做贡献是一件小菜一碟的事 :cake:,请阅读贡献指南。你可以使用问题区讨论表情符号。要向列表添加新的表情符号,请创建一个问题并发送拉取请求,参见如何发送拉取请求并添加gitmoji。
传播
你在项目中使用Gitmoji吗?使用以下代码在你的readme顶部设置Gitmoji徽章:
<a href="https://gitmoji.dev">
<img
src="https://yellow-cdn.veclightyear.com/835a84d5/dc5c6fab-2643-4053-8b71-f3c63d1ad3f2.svg?style=flat-square"
alt="Gitmoji"
/>
</a>
许可证
代码基于 MIT 许可证可用。