Skip to content

ShihaoDevLab/Commits

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 

Repository files navigation

Interesting Space 非强制提交规范

我们使用的 Commit 规范与其他项目有很大的不同,因此请仔细阅读。

Note

此处的 Commit 规范仅为建议性规范,即不必强制遵守。

所有贡献者爱咋写提交记录就咋写(包括我自己)

写在前面:语言规范

很简单,遵守以下几点就行:

  • 保持 Commit 消息使用的语言与项目的 ReadMe 一致。
    • 这也是我们使用表情符号表示 Commit 类型的原因。
  • 在中西混排时,请保持美观
    • 在中文与数字/单词之间增加空格(例如:该软件是我开发的第 114 个软件,使用 Python 开发。
    • 注意大小写!
    • ……
  • ......

第一步:标题

由两部分组成:类型内容

类型分且仅分以下几种,使用表情符号表示:

Note

当我们觉得有必要时,会将某个类型从 Chore 中分离。

目前,可以使用 [未列出类型名称] 提交内容 表示这些类型。

🚀=Feat(功能)
🐛=Fix(修复 Bug)
📄=Docs(文档)
🌐=Web(网站/网页等)
↩️=Revert(通过非 git revert 方式进行的回滚操作)
[不使用 Emoji]=Chore(其他一切类型)
......

此外,还有一种非常特殊的类型,即 Init(🎉),仅在带文件地初始化仓库时使用。

内容部分是对提交内容的概括。

第二步:分点描述

用一段较为简短的话概述内容,然后使用 MarkDown 的无序列表分店写成修改内容。

第三步:备注(可选)

如果你有什么必须要说的话,就把它们写在末尾吧。

还有更多……

如果你使用 VS Code,那么你最好不要在面板中的输入框中输入提交信息,而是在弹出的 COMMIT_EDITMSG 文件中进行输入,并把以下类似的行取消注释:

#
# On branch main
# Changes to be committed:
#	modified:   xxx.cpp
#

以方便查看被修改的文件。

本规则部分参考了 Conventional Commits

About

Interesting Space Commits Specification

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published