提交规范

为什么要制定提交规范?

  • 便于对提交历史进行追溯,以及快速定位
  • 代码改动的历史更加清晰
  • 格式化的 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. 在Rocky8中安装VMware Workstation 的方法

    在Rocky8中安装VMware Workstation 的方法 1.Rocky必须是图形界面 2.下载wmware workstation(下载地址:https://www.vmware.com/i ...

  2. spalsh安装及简单使用

    selenium是浏览器测试自动化工具,很容易完成鼠标点击,翻页等动作,确定是一次只能加载一个页面,无法异步渲染页面,也就限制了selenium爬虫的抓取效率. splash可以实现异步渲染页面,可以 ...

  3. EntityFramework介绍

    首先我们说明一下ORM是什么. 微软官方提供的ORM工具,ORM让开发人员节省数据库访问的代码时间,将更多的时间放到业务逻辑层代码上.开发人员使用Linq语言,对数据库操作如同操作Object对象 一 ...

  4. 抠网页标题栏logo(图标)

    1.打开自己需要抠的网页,例如百度页面 2.在这个网页链接后面+" /favicon.ico " 就可以提取ico图片 3.回车进去,右键鼠标,选择另存为图片就可以成功保存网页中的 ...

  5. IIS 配置集中式证书模块实现网站自动绑定证书文件

    在 Windows 环境下如果采用 IIS 作为 网站服务器时,常规的网站绑定 HTTPS 需要一个一个站点手动选择对应的证书绑定,而且证书过期之后更换证书时也是需要一个个重新绑定操作,无法便捷的做到 ...

  6. HTTPS详解二

    前言 在上篇文章中,我已经为大家介绍了 HTTPS 的详细原理和通信流程,但总感觉少了点什么,应该是少了对安全层的针对性介绍,那么这篇文章就算是对HTTPS 详解一的补充吧.还记得这张图吧. HTTP ...

  7. Ian Lance Taylor

    https://img.mukewang.com/5a9dfda50001933e23006728.png 在GCC的世界中,没有人比Ian更火.在GCC maillist中,Ian的身影呈现在前端中 ...

  8. day32 6 请求转发与重定向的区别、session会话对象 & cookie & 8 应用程序上下文对象ServletContext & 5 请求转发与jsp页面内置对象

    1 请求转发与重定向的区别 2 session与cookie的区别 3 过滤器与监听器的区别 4 web-inf目录 web-inf目录是安全目录,无法从客户端访问,只能通过(服务端的)servlet ...

  9. 使用.NET7和C#11打造最快的序列化程序-以MemoryPack为例

    译者注 本文是一篇不可多得的好文,MemoryPack 的作者 neuecc 大佬通过本文解释了他是如何将序列化程序性能提升到极致的:其中从很多方面(可变长度.字符串.集合等)解释了一些性能优化的技巧 ...

  10. windows安装grunt时提示不是内部或外部命令解决方案

    参考:https://www.cnblogs.com/hts-technology/p/8477258.html 安装windows安装elasticsearch-head时 不需要输入grunt s ...