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)
上一篇 2025年11月5日 下午2:01
下一篇 2025年11月5日 下午2:22


相关推荐

  • Linux的查找命令

    Linux的查找命令

    2021年9月17日
    51
  • 内外网数据库同步方式「建议收藏」

    内外网数据库同步方式「建议收藏」项目环境:公司中心有一个数据库,产品部署地有多个,每个部署地是一个局域网,部署地内有一台对外通讯的服务器(可能会断网)。项目需要将每个部署地的部分数据,同步到中心数据库。基本思路:在需要同步的数据库的说明中添加Update标识,在需要同步的表中添加UpdateDate字段。在每一天的0点时候,会执行一次同步,根据UpdateDate字段进行时间比对,同步会遍历当前数据库的所以后表,如果表中包含

    2022年10月16日
    4
  • Python之numpy库

    NumPy库知识结构

    2021年12月19日
    42
  • debian6 安装 vmtools

    debian6 安装 vmtoolsVmware7自带的tools,在debian5和centos5上都可以正常安装,在debian6上就不ok了,下面是解决方案。1.添加源debhttp://debian.uchicago.edu/debian/squeezemaincontribdeb-srchttp://debian.uchicago.edu/debian/squeezemaincon

    2022年10月19日
    4
  • 国内8大知名工程项目管理软件推荐[通俗易懂]

    国内8大知名工程项目管理软件推荐[通俗易懂]推荐国内比较知名的8个工程项目管理软件:1、PingCode;2、Worktile;3、泛普软件;4、Microsoft Project;5、广联达;6、新中大;7、红圈;8、建文软件。虽然同为工程

    2022年7月2日
    179
  • leetcode-15三数之和(双指针)「建议收藏」

    leetcode-15三数之和(双指针)「建议收藏」原题链接给你一个包含 n 个整数的数组 nums,判断 nums 中是否存在三个元素 a,b,c ,使得 a + b + c = 0 ?请你找出所有和为 0 且不重复的三元组。注意:答案中不可以包含重复的三元组。示例 1:输入:nums = [-1,0,1,2,-1,-4]输出:[[-1,-1,2],[-1,0,1]]示例 2:输入:nums = []输出:[]示例 3:输入:nums = [0]输出:[] 提示:0 <= nums.length <= 300

    2022年8月9日
    9

发表回复

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

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