加入收藏 | 设为首页 | 会员中心 | 我要投稿 新余站长网 (https://www.0790zz.com/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 综合聚焦 > 移动互联 > 应用 > 正文

在使用Git时你需要这样提交代码

发布时间:2021-05-23 16:05:23 所属栏目:应用 来源:互联网
导读:目前大部分公司都在使用 Git 作为版本控制,每个程序员每天都要进行代码的提交。很多开发者也包括我自己,有时候赶时间或者图省事,就这么提交: git commit -m

git commit -m "修改bug,优化代码" 

过了一段,突然去查找一个具体的提交你会发现不是特别好找。因此我们需要规范我们的代码提交来避免这种情况。同时良好的提交规范也有助于我们生成清晰的 ChangeLog,更利于同事之间的协作。

如果你想成为知名开源项目的贡献者更要规范自己的代码提交。

2. Git 提交规范

目前业内做的比较好的,比较具有参考价值的就是知名前端框架AngularJS的提交规范。我们先来看一个例子:

对应的格式:

<type>[optional scope]: <description> 

# 空行 

[optional body] 

# 空行 

[optional footer] 

更严格的项目可能提交要求使用英文描述,特别是国际化的开源项目。

根据上面这个例子我们来了解一下这个业界比较认可的 Git 提交规范。

type

refactor 表示本次提交的是重构代码,也就是它是一个提交的类型type,除了refactor还有:

feat 新功能,顾名思义就是新需求的实现。

fix 修复,就是对 bug 的修复。

docs 文档,主要用来描述文档的变更。

style 主要是代码风格相关的提交,比如格式化等。

refactor 重构代码,对已有功能的重构,但是区别于 bugfix。

test 测试相关的提交,不太常用。

chore 构建过程或辅助工具的变动,不太常用,比如之前用 Maven,后面换成了 Gradle。

每次提交声明提交的type是必须的,它让本次提交的作用一目了然。

scope(可选)

用来表明本次提交影响的范围,方便快速定位。你可以写明影响的是哪个模块(通常是模块名称)或者是哪个层(数据层、服务层、还是视图层)。

(编辑:新余站长网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

    热点阅读