开始使用

我们喜欢保持项目历史的整洁。我们的提交规范受到了 Conventional Commits 的启发，但使用 gitmoji 进行了自定义，让它更加直观和有趣。

结构

提交信息应按以下结构撰写，全部小写：

<gitmoji> <type> <description> [(#<issue number>)]

[可选正文]

[可选脚注]

示例

📝 更新文档贡献者

- 添加 @jerembdn 作为贡献者
- 添加 @younesbessa 作为贡献者

共同作者：Younes Bessa <[email protected]>

大多数时候，一句简单的单行就足够了：

📝 更新文档贡献者

类型

我们使用以下提交类型：

存储库的首次提交使用 initial，版本标签使用 release：

🎉 初始提交
🔖 发布 @onruntime/translations v0.3.0

描述

<type> 是主语的动词，而描述则是对其的补充。结合起来，它们组成 一个句子：

# 好
📝 更新文档贡献者

所以不要用第二个动词开头描述。类型已经是一个动词，主语最终堆叠了两个句子，这就是 fix: 前缀导致的。去掉动词，保留所操作的内容：

# 不好
💄 改进缩小卡片上的宝石
🐛 修复页脚换行

# 好
💄 改进卡片上的宝石大小
🐛 修复页脚换行

以 祈使语气 和 小写 撰写：

# 不好
📝 更新文档贡献者

# 不好
📝 更新文档贡献者

问题编号

通过添加问题编号来链接提交和问题：

📝 更新文档贡献者 (#123)

正文

使用正文提供背景和动机：

📝 更新文档贡献者

- 添加 @jerembdn 作为贡献者
- 添加 @younesbessa 作为贡献者

共同作者：Younes Bessa <[email protected]>