当前位置: 首页 > 后端技术 > Java

git提交也有规范,来看看鹅厂是怎么做的

时间:2023-04-01 14:36:10 Java

1、无规矩不成规矩。一套完整的规范不利于阅读和维护。所以需要一套git提交规范,让提交记录清晰明了,让人一眼就知道这次提交的目的。2.业界公认和通用的标准AngularJS是目前使用最广泛的规范,更加合理和系统,并有相应的工具和插件支持。规范结构:由header(key)、body(可省略)、footer(可省略)三部分组成,建议这三部分不要超过100个字符,以免影响自动换行外观上//Header()://空行//空行

1.header(key)记录主要修改类型和内容,由三部分:type(必填)、scope(可选)、subject(必填)1.1、type必填,message的类型,有几个常用的typesfeat:提交新features,memory:featurefix:solvebugdocs:修改内容与文档相关,memory:documentationstyle:修改格式,不修改代码逻辑,如格式化,换行等perf:performance,体验优化等memory:performanceperformancetest:增加新的测试用例或修改已有的测试用例chores:构建过程或辅助工具的变化,非src和测试修改,如构建过程,依赖管理等,同时有feat,fix等类型时,类型为feat和fix。1.2、scope非必填,用于说明本次投稿的影响范围,如数据层、控制层、视图层等1.3、subject必填,本次投稿的简短描述以第一人称开头动词的现在时,如add,不用added,adds首字母小写,句末不加句号(.)2.正文(可省略)详细说明,可多-line,header之间有一个空行3.footer(可以省略)footer只用在下面两种情况下,不兼容的变化以BREAKINGCHANGE开头,后面是变化的描述,变化的原因,以及迁移方法。什么是不兼容的改变,比如改变了用户密码的加密方式?关闭当前提交修改一个issue的整体问题git消息如下feature(datalayer):Shortdescription详细描述BREAKINGCHANGE:IncompatiblechangesCloses关闭issue3.idea插件知道提交规范,但是我应该怎么办经常记不住格式怎么办?这个时候强大的idea插件GitCommitMessageHelper就真香了1.在settings->plugins中安装,搜索GitCommitMessageHelper,点击安装,重启即可。2.在git提交页面使用,点击createcommitmessage按钮,弹出如下窗口,编辑好后点击ok,在如下弹窗中输入信息,提交消息如下关注公众号:甄大虾,分享java后端技术干货,每天进步一点点