提交规范

为什么要制定提交规范?

  • 便于对提交历史进行追溯,以及快速定位
  • 代码改动的历史更加清晰
  • 格式化的 Commit Message 才可以用于自动化输出 Change log

如何制定提交规范?

业界通用的Git提交规范:

<type>(<scope>):<subject>
  • 先来说type:用于说明 Git Commit 的类别,只允许使用下面的标识:

    sync:同步主线或分支的bug。

    merge:代码合并。

    revert:回滚到上一个版本。

    chore:构建过程或辅助工具的变动。

    test:增加测试。

    perf:优化相关,比如提升性能、体验。

    refactor:重构(既不是新增功能,也不是修改bug的代码变动)。

    style:格式(不影响代码运行的变动)。

    docs:文档(documentation)。

    fix / to:修复bug,可以是QA(Quality Assurance)发现的bug,也可以是研发自己发现的bug。

    feat:新功能(feature)
  • 接下来是scope,顾名思义,就是影响范围,是数据层,控制层,还是视图层?

    在JAVA,可以是Controller,Service,Dao等。

    在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。

    如果你的修改影响了不止一个scope,你可以使用*代替。
  • 最后,subject ,就是描述啦~~这个就不说啦
  • 举例:本次代码修改是优化了xxx
git commit -m "feat(Controller):本次新增加了功能用来xxx"

提交要求

  • 一次提交(commit)只能是一个变更或功能,不允许一次提交多个变更和功能,便于版本回溯及检查

  • 代码提交之前和提交之后必须做如下检查

    1.提交修改之前必须验证是否可编译通过、是否已完全解决此问题、是否会导致其他问题

    2.对于重要任务,提交后必须重新克隆一份代码验证此次提交是否可编译通过不会导致其他问题。

来说一下常用命令吧~~

git个人信息设置

  • 用户名设置:git config --global user.name
  • 用户邮箱设置:git config --global user.email

    示例:
git config --global user.name xiaojin
git config --global user.email xiaojin@lovecode.com

最最最常用的几个命令

  • 显示状态信息
git status
  • 添加提交任务
git add .
  • 获取远程更新并合并到本地仓库
git pull
  • 将暂存区任务提交到本地仓库并添加说明
git commit -m "perf(View): 优化了xxx视图"
  • 将当前提交推送到远程仓库
git push
  • 查看配置信息
git config --list
git config user.name

添加远程仓库

git remote add <shortname> <url>
  • 查看远程仓库

    运行git remote命令。它会列出指定的每一个远程服务器的简写。如果已经克隆了远程仓库,那么应该至少能看到origin,这是git克隆的仓库服务器的默认名字

欢迎大家指出文章需要改正之处~

学无止境,合作共赢

欢迎路过的小哥哥小姐姐们提出更好的意见哇~~

最最最常用的Git提交规范以及常用命令总结的更多相关文章

  1. 开发中的你的Git提交规范吗?

    1. 前言 目前大部分公司都在使用Git作为版本控制,每个程序员每天都要进行代码的提交.很多开发者也包括我自己,有时候赶时间或者图省事,就这么提交: git commit -m "修改bug ...

  2. 前端规范之Git提交规范(Commitizen)

    代码规范是软件开发领域经久不衰的话题,几乎所有工程师在开发过程中都会遇到或思考过这一问题.而随着前端应用的大型化和复杂化,越来越多的前端团队也开始重视代码规范.同样,前段时间,笔者所在的团队也开展了一 ...

  3. 利用shell脚本生成CHANGELOG.md(包含git提交规范)

    前言 我们经常看到github上面有很多CHANGELOG.MD包含版本的更新信息,如果我们的git提交能遵循一定的规范,那么使用gitlog就能很方便的生成它 生成结果  shell脚本 http ...

  4. git 提交规范

    git 提交规范 前言 无规矩不成方圆,编程也一样. 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你.可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项 ...

  5. 项目工程化之git提交规范以及 CHANGELOG生成

    事先声明,本文是参考了其他大神的博客之后自己尝试的记录,具体可以参考如下 链接 先说说git 提交规范把,这里基本都是这个工具 cz-customizable 1,安装 npm install cz- ...

  6. 老鸟都应该注意的git 提交规范

    不知道大家有没有看过自己项目的git 提交信息-----我看过好多次 ,不忍直视  然后提醒一起的小伙伴 :大家规范点 信息要详细, 过段时间再看下 ,还是一样. 相信很多猿都有这样的感受,对于垃圾的 ...

  7. 关于Git提交规范

    自古至今,无规矩不成方圆. Git提交也有其规范,业内做的比较好的,比较具有参考价值的就是Angular的提交. Angular提交规范: <type>(<scope>): & ...

  8. 你可能会忽略的 Git 提交规范

    一.为什么需要规范? 无规矩不成方圆,编程也一样. 如果你有一个项目,从始至终都是自己写,那么你想怎么写都可以,没有人可以干预你.可是如果在团队协作中,大家都张扬个性,那么代码将会是一团糟,好好的项目 ...

  9. Git提交规范

    Commit message 的格式 每次提交,Commit message 都包括三个部分:Header,Body 和 Footer. <type>(<scope>): &l ...

  10. Git提交代码规范 而且规范的Git提交历史,还可以直接生成项目发版的CHANGELOG(semantic-release)

    Git提交代码规范 - 木之子梦之蝶 - 博客园 https://www.cnblogs.com/liumengdie/p/7885210.html Commit message 的格式 Git 每次 ...

随机推荐

  1. 19.-哈希算法&注册登录

    一.哈希算法 哈希: 给定明文-计算出一段定长的-不可逆的值 定长输出:不管明文输入多少,哈希都是定长的 不可逆:无法反向计算出对应的明文 雪崩效应:输入改变,输出必然变 md5:32位16进制   ...

  2. SpringBoot 过滤器和拦截器

    过滤器 实现过滤器需要实现 javax.servlet.Filter 接口.重写三个方法.其中 init() 方法在服务启动时执行,destroy() 在服务停止之前执行. 可用两种方式注册过滤器: ...

  3. 创建base公共组件

    公共模块 基础模块参照了vant的思路,使用bem命名规范.先创建一个命名空间,这个命名空间返回创建组件函数与生成命名方法.在创建组件函数中创建name与install属性用于注册vue组件 创建组件 ...

  4. day12-Servlet02

    Servlet02 6.GET和POST请求的分发处理 开发Servlet,通常编写doGet,doPost方法.来对表单的get和post请求进行分发处理 例子 在web文件夹下面创建一个html页 ...

  5. 质数之和【计算第x个到第y个质数之和】

    题目:质数之和 已知,第一个质数是2,第二个质数是3,第三个质数是5,第四个质数是7,第五个质数是11,第六个质数是13,第七个质数是17,输入两个不相等的正整数a和b,求出第a个质数到第b个质数当中 ...

  6. Vue3 企业级优雅实战 - 组件库框架 - 4 组件库的 CSS 架构

    在前一篇文章中分享了搭建组件库的基本开发环境.创建了 foo 组件模块和组件库入口模块,本文分享组件库的样式架构设计. 1 常见的 CSS 架构模式 常见的 CSS 架构模式有很多:OOCSS.ACS ...

  7. C#在Xp系统执行.exe程序的报错怎么查看原因

    我的电脑---->管理---->事件查看器----->应用程序,查看错误来源

  8. 8.drf-序列化器

    在序列化类中,如果想使用request,则可以通过self.context['request']获取 序列化器的主要由两大功能 - 对请求的数据进行校验(底层调用的是Django的Form和Model ...

  9. 使用python玩转二维码!速学速用!⛵

    作者:韩信子@ShowMeAI Python3◉技能提升系列:https://www.showmeai.tech/tutorials/56 本文地址:https://showmeai.tech/art ...

  10. 【书籍知识回顾与总结-2022】Java语言重点知识-多线程编程、流式编程

    一.多线程编程 二.流式编程 1.目的 简化集合和数组的操作 注意:每个流只能使用一次 2.获取流的方式 (1)单列集合:stream方法 KeySet()/values()/EntrySet() ( ...