讲师博文
2023年了,还有前端人不知道 commit 规范? 来源 : 华清远见     2023-11-01

什么是commit规范?

约定式提交(Conventional Commits)是一种用于代码版本控制的规范,旨在通过明确和标准化提交信息来提高代码协作质量和效率。其基本原则是通过规定提交信息的结构和语义来提高代码版本控制的可读性、可维护性和自动化程度。

点单来说,commit 规范是一种约定俗成的代码提交规则,皆在提供一种同意的格式,是团队成员能够更好的理解和管理代码的变更历史。通过遵循 commit规范,可以更清晰的了解每个代码提交的目的和意义,从而提高代码的可读性、可维护性和协作效率。

commit的作用是什么?

约定式提交规范通常要求提交信息包括一个描述性的"类型"、一个可选的"作用域"、一个用于简洁说明的"主题",以及可选的"正文"和"尾部"等组成部分。这些组成部分的格式和语义都是根据规范要求进行约定的,比如使用"feat"来表示新功能、"fix"表示修复错误、"docs"表示文档变更等。

通过遵循约定式提交规范,开发人员可以更容易地理解和管理代码的变更历史,同时也为自动化工具提供了更多可靠的信息,例如自动生成版本号、发布日志和代码库更新等操作。

在当今的软件开发领域,版本控制是一个至关重要的环节。无论是个人项目还是团队合作,版本控制系统都能帮助我们跟踪代码的变化、协作开发和回滚不必要的更改。而在版本控制中,Git已经成为了最受欢迎的工具之一。

然而,尽管很多前端开发人员已经开始使用Git进行版本控制,但仍然有一些人对如何正确提交代码存在一些困惑。

为什么要遵循 commit 规范?

我们来看一下不规范的commit记录:

大家看完以后是什么感觉,写的全是update,这种commit信息对于想要从信息中获取有效信息的人来说简直就是噩梦。

我们来看一个Angular团队 的commit记录:

我们很明显就可以看出两者的区别所在。

上图中这种规范的commit 信息提供了更多的历史信息,方便快速浏览。再者,可以过滤某些commit(如文档改动信息),便于快速查找信息。

 

下面我们具体深入了解一下commit规范。

 

如何遵循 commit 规范?

Commit Message的规范有以下几种:

 

 

 

 

 

其中 Angular团队 的规范是目前社区比较流行的commit规范,他在功能上能够满足开发者commit需求,在格式上清晰易读,目前也是用的最多的。





 


扫码申领本地嵌入式教学实录全套视频及配套源码

上一篇:我已经不用try-catch处理异常了?

下一篇:嵌入式工程师,如何用好C语言?

400-611-6270

Copyright © 2004-2024 华清远见教育科技集团 版权所有
京ICP备16055225号-5京公海网安备11010802025203号