开始使用

了解我们的提交规范

1 min read
155 words

我们喜欢保持项目历史的干净。我们的提交规范受到 Conventional Commits 的启发,但结合了 gitmoji,让它更具视觉效果和乐趣。

结构

提交信息应按以下格式结构化,并且使用小写

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

[可选正文]

[可选页脚]

示例

📝 更新文档贡献者

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

共同撰写者: Younes Bessa <[email protected]>

大多数时候,一个简单的一行就足够了:

📝 更新文档贡献者

类型

我们使用以下提交类型:

类型描述
add添加新功能
fix修复一个错误
improve改善某些东西
update更新某些东西
remove移除某些东西
refactor重构某些东西
rename重命名某些东西
move移动文件或文件夹
upgrade升级依赖
downgrade降级依赖

描述

命令式语气小写来写描述:

# 好
📝 更新文档贡献者

# 不好
📝 更新了文档贡献者

# 不好
📝 Update documentation contributors

问题编号

通过添加问题编号将提交链接到问题:

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

正文

正文用于提供上下文和动机:

📝 更新文档贡献者

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

共同撰写者: Younes Bessa <[email protected]>

一次提交,一个目的

每个提交应代表一个单一的逻辑变更。不要混合不相关的变更。