当前位置: 首页 > 科技观察

使用Git时,应该这样提交代码

时间:2023-03-17 18:35:04 科技观察

1。前言目前大部分公司都在使用Git作为版本控制,每个程序员每天都要提交代码。很多开发者,包括我自己,有时会匆忙提交或者图省事:gitcommit-m"修改bug,优化代码"。所以我们需要规范我们的代码提交来避免这种情况。同时,良好的提交规范也帮助我们生成清晰的ChangeLog,更有利于同事之间的协作。如果你想成为一个知名开源项目的贡献者,你必须规范你的代码提交。2、Git提交规范目前在业界比较好的,比较有参考价值的是知名前端框架AngularJS的提交规范。先看一个例子:Git提交信息对应的格式:[optionalscope]:#空行[optionalbody]#空行[optionalfooter]比较严格的项目可以提交英文描述,尤其是面向国际的开源项目。根据上面的例子,我们来看看目前业界比较认可的Git提交规范。typerefactor表示提交的代码是refactoring,即是提交的type类型。除了refactor,还有:featNewfunctions,顾名思义,就是新需求的实现。Afix是针对bug的修复。docs文件,主要用来描述文档的变化。style主要是和代码风格提交有关,比如格式化等。refactor重构代码,重构已有的功能,但是不同于bugfix。test测试相关的提交,不太常用。杂项施工过程中的变化或辅助工具不常用。比如之前用的Maven,后来换成Gradle。每条提交语句提交的类型都是必填项,使得本次提交的作用一目了然。scope(可选)用于表示本次提交的影响范围,方便快速定位。您可以指定受影响的模块(通常是模块名称)或层(数据层、服务层或视图层)。主题是上面修改后的版权信息,是对本次投稿的简短描述和总结。就像胖哥写文章需要起标题一样,不要写得太长。body(optional)是对本次提交涉及的项目的更详细的描述,并列出了代码功能。在这里,胖哥习惯于使用markdown列表语法,即用破折号和换行符分隔项目。当然,正文不是必须的,只要主题能描述清楚即可。foot(可选)描述与此提交相关的中断更改或问题。breakchange表示本次提交是否产生了破坏性变化,如版本升级、接口参数减少、接口删除、迁移等,如果出现上述影响,强烈建议在提交信息中写上breakchange,即有利于出现问题时快速定位、回滚、恢复。Issue如果你发现项目有bug,或者有优化建议,甚至是增加新任务,都可以使用issue向项目提交任务。Gitissue问题并不是某些Git平台的专属功能。JIRA等平台也有类似的功能。它们的功能相似,能够很好的反映项目的成长状态和参与度。那么在Git提交的时候,我们可以在脚区关联本次提交涉及的issue。#参考issuesissues#F12YC,#F45JW#关闭Closes#F12YC这里没有固定的格式,尽量参考一些知名项目来做。3.工具安利说了这么多,相信大家已经对Git提交的规范有所了解了。以下是推荐的一些有用工具,可帮助您落实这些规范。IntellijIDEA的插件市场上有很多GitCommitMessage模板插件,可以直观的实现这些规范。Git提交信息插件本文转载自微信公众号“码农小胖哥”,可通过以下二维码关注。转载本文请联系码农小胖公众号。