Git规范:Git提交规范

Git规范:Git提交规范1 Commitmessag 格式 type scope subject 1 type 必须 作用 用于说明 Gitcommit 的类别 只允许使用下面的标识 feat 新功能 feature fix to 修复 bug 可以是 QA QualityAssur 发现的 BUG 也可以是研发自己发现的 BUG 备注 fix 产生 diff 并自动修复此问题 适合于一次提交直接修复问题 to 只产生 diff 不自动修复此问题 subject scope type

目录

一、为什么要制定提交规范?

二、如何制定提交规范?

三、具体案例


一、为什么要制定提交规范?

  1. 便于程序员对提交历史进行追溯,了解发生了什么情况。
  2. 一旦约束了 Commit Message ,意味着我们将慎重的进行每一次提交,不能再一股脑的把各种各样的改动都放在一个git commit里面,这样一来整个代码改动的历史也将更加清晰。
  3. 格式化的 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
    • 作用
      • scope用于说明 Commit 影响的范围,比如数据层、控制层、视图层等,视项目不同而不同。
    • 例子
      • 在JAVA,可以是Controller,Service,Dao等。
      • 在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。
      • 如果你的修改影响了不止一个scope,你可以使用*代替。
  • subject
    • 作用
      • subject是 Commit 目的的简短描述,一般不超过50个字符。
    • 注意事项
      • 建议使用中文。
      • 结尾不加句号或其他标点符号。

三、具体案例

feat(Controller):用户查询接口开发 fix(Dao):用户查询缺少username属性

以上就是Git的提交规范和具体案例,如果本篇文章对你有帮助,请一键三连支持,谢谢。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/232045.html原文链接:https://javaforall.net

(0)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • css3很美的蟠桃动画

    查看效果:http://hovertree.com/texiao/css3/26/源码下载:http://hovertree.com/h/bjaf/ndhxgfkn.htm效果图如下:代码如下:转自

    2021年12月26日
    36
  • idea中撤销操作_eclipse反撤销快捷键

    idea中撤销操作_eclipse反撤销快捷键在刚使用idea的小伙伴都会遇到这样一个问题就是,习惯性地使用ctrl+y进行反撤销。但是却把该行代码删除了,哈哈哈:D.这谁都遇到过的。因为在idea中ctrl+y就是删除该行的快捷键,那么在idea中的反撤销快捷键是什么呢?其实是,ctrl+shift+z。但是可能你用了还是没效果,那是因为你PC上别的软件占用了该快捷键。我知道的就有搜狗输入会占用该快捷键~那我们取消搜狗输入法的这个快捷键…

    2022年10月2日
    5
  • linux dhcp服务器搭建_如何自己搭建服务器

    linux dhcp服务器搭建_如何自己搭建服务器本篇是关于在Linux服务器上安装并配置DHCP服务器的配置教程!

    2025年7月27日
    4
  • intellidea激活码[最新免费获取]「建议收藏」

    (intellidea激活码)最近有小伙伴私信我,问我这边有没有免费的intellijIdea的激活码,然后我将全栈君台教程分享给他了。激活成功之后他一直表示感谢,哈哈~IntelliJ2021最新激活注册码,破解教程可免费永久激活,亲测有效,下面是详细链接哦~https://javaforall.net/100143.html…

    2022年3月27日
    220
  • 临界段CCriticalSection的使用[通俗易懂]

    临界段CCriticalSection的使用[通俗易懂]类CCriticalSection的对象表示一个“临界区”,它是一个用于同步的对象,同一时刻仅仅同意一个线程存取资源或代码区。临界区在控制一次仅仅有一个线程改动数据或其他的控制资源时很实用。比如,在链表中添加�一个结点就仅仅同意一次一个线程进行。通过使用CCriticalSection对象来控制链表,就能够达到这个目的。它就像是一把钥匙,哪个线程获得了它就获得了执行线程的权力,而把其…

    2022年7月20日
    12
  • nopcommerce mysql_NopCommerce用.net core重写ef

    nopcommerce mysql_NopCommerce用.net core重写ef最近看了 NopCommerce 源码 用 core 学习着写了一个项目 修改的地方记录下 项目地址 NopCommerce 框架出来好久了 18 年的第一季度懒加载出来后也会全部移动到 netcore 那么就更好玩了 项目内容模仿部分分层模式引擎机制 DI 容器 EF 仓储模式 Mapping 部分修改 netcore 重写类库 EFcoremysql 动态加载 dbset 当然 NopCommerce 还包含很多特技 P

    2026年1月26日
    1

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号