关于git commit 的一些执行规范

相关材料

官方文档
官方文档-中文

背景

git commit message 是我们使用 git 进行代码提交时的日常操作。写好 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG, 对项目的管理实际至关重要, 但是实际工作中却常常被大家忽略。尤其是对于大型协作项目,commit的内容对于项目的维护非常重要。

一些工具

commitizen

终端工具commitizen是一个基于npm的版本控制工具集,仓库内包含多个提交工具,cz-cli是commit提交的命令行程序;cz-conventional-changelog 提供了日志的生成标准。

1
2
# 安装
npm install -g commitizen # 基于npm进行安装

commitizen-tools

是一个基于python的发布管理工具。提供了一套标准版本管理和提交的规范,同时用户可以进行一定的自定义设置。
说明文档
示例
image

1
2
3
# 安装
conda install -c conda-forge commitizen #基于conda进行安装
pip install --user -U Commitizen #基于pip 进行安装

conventional-changelog/standard-version 一步解决提交信息和版本发布。

一些moji标记

https://gitmoji.dev/

##
commit规范

参考资料

知乎

-------------本文结束感谢您的阅读-------------