git commit日志基本规范
利用git的commit指令提交代码我想大家都知道,但是git的commit的日志内容其实也是有所讲究的,为了更好的维护代码,应该提升git的commit日志信息的可读性,这样可以方便以后更好的查看提交的代码记录,也方便更好的维护代码,所以有良好的代码日志规范也是很重要的
git的日志格式
<type>(<scope>): <subject><BLANK LINE><body><BLANK LINE><footer>
type详解
type表示某次提交的类型,比如是修复一个bug还是增加一个新的功能,type的类型如下:
- feat 表示新增功能
- fix 修复bug
- docs 仅仅修复了bug文档,例如readme这些文档
- style 修改了样式,但不改变代码的逻辑
- refactor 代码重构,没有新增功能,也没有修改bug
- pref 优化相关,比如提升性能,体验
- test 测试用例,例如单元测试,集成测试
- chore 改变构建流程,或者添加依赖库和工具
- revert 回滚到上一个版本
其它部分解释
标题行
50个字符以内,描述主要变更内容
主体内容
更详细的说明文本,建议72个字符以内
尾部
如果需要的化可以添加一个链接到issue地址或者其它文档,或者关闭某个issue