当前位置:   article > 正文

Java中Git代码提交规范_代码提交规范 java

代码提交规范 java

今天在写项目,提交代码时发现,别人在提交代码时总要加上一些前缀比如Fix:优化细节。便去了解一下,收获一个小细节。

概述

每当完成一个功能、或修改了一个bug、调整格式、重构模块的时候,都应该commit一次代码,以便git记录这次修改。

规定:在提交时不能将不相关的修改一块提交,比如:配置文件,自己在本地做的修改等与这次提交内容无关的文件。

代码提交格式

<type>:<subject>
//空行
<body>
  • 1
  • 2
  • 3

type

  • 用于说明本次提交类型
  • feat:新增功能
  • fix:修复bug
  • docs:修改文档,readme.md等
  • test:增加测试用例,包括单元测试,集成测试等。
  • style:修改了空行、索引个数、引用包排序等。
  • perf:优化相关内容,性能提升、体验等
  • refactor:代码重构,没有新功能或者修复bug
  • chore:改变构建流程,或新增依赖库、工具等。
  • revert:回滚上一个版本
  • merge:代码合并

subject

是commit目的的简短描述不超过50-80个字符,subject之前有一个空格,在浏览有很多消息的历史记录是,多个空格,更方便阅读。

body

对本次提交的详细描述,可分多行
body之前有一个空行,为了浏览日志中只显示提交的简要说明。
如果type是fix修复错误,必须在body中记录一下信息:重新错误的步骤;预期应有的行为,观察到的错误行为,那当提交的说明已经能说明时,body部分就可以省略。

提交举例

在这里插入图片描述
在这里插入图片描述

有任何想要讨论和学习的问题可联系我:577371067@qq.com 不足之处请大家指正。

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/你好赵伟/article/detail/496526
推荐阅读
相关标签
  

闽ICP备14008679号