本页面将简单描述本博客仓库的 git 提交信息格式。
commit 中可以包含不完全符合要求情况的更改,但是需要更改与主要符合情况的更改相关(例如为增加文件更改配置文件,commit 信息需要按照增加文件编写)
文章的变更
在提交文章变更时,提交信息应该遵循以下格式:
1 | [变更类型][文章系列]: 文章标题 |
其中,变更类型可以是以下几种:
- ADD:添加文章
- DEL:删除文章
- FIX:修复文章
- UPD:更新文章
文章系列通常为 POST
,即该文章不属于任何系列。如果文章属于某个系列,例如 月总结
、LCTT 原创翻译转载
,则此处填写系列名。
文章标题为文章的标题,例如 使用终端命令别名快速编译运行代码
。如果文章需要前缀,则使用 []
包裹前缀并在后面加空格,例如 [新闻] Kate 文本编辑器增加了四个非常棒的新功能
。
知识库内容的变更
在提交知识库内容的变更时,提交信息应该遵循以下格式:
1 | [变更类型][wiki/知识库文件夹名称]: 更改内容描述 |
其中,变更类型可以是以下几种:
- ADD:添加文章
- DEL:删除文章
- FIX:修复文章
- UPD:更新文章
知识库文件夹名称为 wiki
路径下的,存储知识库内容的文件夹名称,例如 pgp
。
单独页面的变更
在提交单独页面的变更时,提交信息应该遵循以下格式:
1 | [变更类型][页面标题]: 变更描述 |
其中,变更类型可以是以下几种:
- ADD:添加页面
- DEL:删除页面
- FIX:修复页面
- UPD:更新页面
页面标题为页面的标题,例如 主页
、联系我
、Git 提交信息格式
等。
更新主题
更新主题时使用以下内容:
1 | build: Update theme |
更新 Hexo 配置/主题配置
在更新 Hexo 配置或主题配置时使用以下内容:
1 | chore(配置文件名): 更改内容描述 |
配置文件名应为 _config.yml
或 _config.stellar.yml
。
更新数据文件
在更新数据文件时,提交信息应该遵循以下格式:
1 | chore(_data/文件名): 更改内容描述 |
其中文件名应为在 _data
目录下的文件名,例如 widgets.yml
。
更新其他文件
对于其他文件的更新,假如文件属于内容类型文件(README、LICENSE 等不属于内容类型),则使用以下格式:
1 | [变更类型][文件名]: 变更描述 |
其中,变更类型可以是以下几种:
- ADD:添加文件
- DEL:删除文件
- FIX:修复文件
- UPD:更新文件
如果文件属于 README、LICENSE 或代码类型文件(.gitignore、.editorconfig 等属于代码类型),则依照 约定式提交 编写提交信息。