git规范指南

一、分支与命名规则说明

1.1、Git 分支类型

master 分支(主分支) 稳定版本

develop 分支(开发分支) 最新版本

release 分支(发布分支) 发布新版本(预发布版本,可不用)

hotfix 分支(热修复分支) 修复线上Bug

feature 分支(特性分支) 实现新特性,新需求

1.2、命名规则

示例施工宝:

sgb (原master分支)

sgb-develop (开发分支)

sgb-feature (新功能分支)

sgb-2.2.1-hotfix (修复线上bug)

项目分支命名

sgb-fangte (方特项目)

sgb-zhihe (致和项目)

jiake-master,jiake-develop (佳科项目)

ynkeenly-master,ynkeenly-develop (佳科项目)

1.3、readme规范

新建项目必须在根目录下新建xx-readme.md,例如jiake-readme.md,以日期或者版本来维护每次更新内容,示例如下:

2.0.28.1 2020-10-23 update by blueeyedboy
员工信息查询:专职业资格列表SQL zsj 2020-10-21 11:41
提交本地代码并且获取最新代码 zsj 2020-10-21 11:38
员工信息查询专职业资格列表SQL zsj 2020-10-21 10:55

二、分支简明使用流程

2.1 使用流程

   (1) 初始化

开发主管提交代码初始版本到master 分支,公司命名为sgb(以下说的master分支指sgb)。

开发主管在master 分支上创建develop 分支(开发分支),master 分支与develop 分支一样,有且仅有一个;命名为sgb-develop。

(2) 开发新功能

当有新需求或新的研究时创建一个feature 分支;从develop分支拉取,命名为sgb-develop-feature;

开发人员从sgb-develop-feature分支中checkout一个新的分支用于开发新功能,命名为 sgb-feature-新功能特性-用户名;如:sgb-feature-meterial-linjun;

(3) 发布测试和发布版本

开发人员开发完毕后,合并到feature分支,feature打包测试,测试通过,将代码合并回develop分支。

master(即sgb)合并develop分支代码,发布新版本sgb-2.1.1-时间tag,如:sgb-2.1.1-20201010。

(4) 线上修复

从某个线上版本上checkout 一个分支用于修复线上bug,如:sgb-2.1.1-20201010 上 checkout 一个新分支 sgb-2.1.1-hotfix

直接hotfix分支打包测试,测试通过后发布一个新版本,如:sgb-2.1.1.1-20201011,并将hotfix合并到master分支,然后删除hotfix分支。

(5) 项目分支,示例方特项目

从master或者某一版本上 拉取一个新分支用于项目开发,如:sgb-2.1.1-20201010 上 checkout –个新分支 sgb-fangte

在项目分支上,如:sgb-fangte 上拉取分支 sgb-fangte-develop 用于开发,同时拉取hotfix分支,用于修复目前存在的bug

从开发分支上拉取一个新分支用于开发新功能特性,如:sgb-fangte-develop 拉取分支 命名为sgb-fangte-feature

开发人员从sgb-fangte-feature分支中checkout一个新的分支用于开发新功能,命名为 sgb-fangte–feature-新功能特性-用户名;如:sgb-fangte–feature-ims-linjun;

开发人员开发完毕后,合并到feature分支,feature打包测试,测试通过,将代码合并回develop分支。

项目主分支(sgb-fangte)合并develop分支代码,发布新版本sgb-fangte-2.1.1-时间tag,如:sgb-fangte-2.1.1-20201017。

在线上版本上checkout 一个分支用于修复线上bug,如:sgb-fangte-2.1.1-20201017 上 checkout 一个新分支 sgb-fangte-2.1.1-hotfix

hotfix分支打包测试,测试通过后发布一个新版本,如:sgb-2.1.1.1-20201011,并将hotfix合并到项目主分支(sgb-fangte),然后删除hotfix分支。

2.2 git思维导图

以上流程参考以下思维图

在这里插入图片描述

三、目前git仓库情况

3.1 移动端

Master分支 改为sgb

sgb-v2版本,最新为v2.1.14

sgb-v3版本,最新为v3.1.4,即将发布 3.2.0 (物资库)

方特项目fangte-1.0.1,基于v2.1.1 分支

线上修复,目前分支 hotfix-v3.1.4

新特性,v3.2.0-20201014,需要合并v3.2.0-20201014-linjun 代码

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Git 提交规范是指在提交代码时,按照一定的规范来书写提交信息。这些规范包括提交信息的格式、提交信息的内容等方面。采用 Git 提交规范可以提高代码的可读性和可维护性,方便项目的管理和协作开发。 下面是一个常用的 Git 提交规范引入指南: ## 为什么需要 Git 提交规范? 在协作开发项目的过程中,经常会遇到多人同时修改同一个文件的情况。如果每个人提交的代码都采用不同的格式和风格,那么在后期维护和合并代码时就会变得非常困难。因此,为了方便团队协作开发,需要对提交信息进行规范化。 ## Git 提交规范的格式 Git 提交规范的格式通常由三部分组成:标题、空行和正文。 ### 标题 标题是提交信息的第一行,通常不超过 50 个字符。它应该简明扼要地描述本次提交所做的修改。 例如: - 添加了用户注册功能 - 修复了登录页面的样式问题 - 更新了项目文档 ### 空行 标题和正文之间需要空一行,以便于阅读。 ### 正文 正文是提交信息的详细描述,通常包括以下三个部分: 1. 修改的原因: 描述为什么需要做这个修改,它的背景和目的是什么。 2. 修改的内容: 描述具体做了哪些修改,包括新增、修改、删除等操作。 3. 具体实现方式: 如果有必要,可以简要地描述修改的具体实现方式。 例如: ``` 添加了用户注册功能 为了让用户能够注册账号,我们添加了新的注册页面和注册接口。同时,我们还更新了首页和登录页面,让用户能够更方便地进行注册和登录操作。 - 添加了注册页面和注册接口 - 更新了首页和登录页面 - 注册页面采用了表单验证和验证码验证的方式 ``` ## Git 提交规范的内容 在提交代码时,需要遵循一定的提交规范。下面是一些常用的提交规范: 1. feat:新功能 例如:添加了用户注册功能 2. fix:修复问题 例如:修复了登录页面的样式问题 3. docs:文档修改 例如:更新了项目文档 4. style:代码格式修改 例如:调整了代码缩进和空格 5. refactor:代码重构 例如:重构了用户注册功能的代码 6. test:测试代码修改 例如:增加了用户注册功能的单元测试 7. chore:其他修改(如构建过程或辅助工具的变动) 例如:更新了依赖库的版本号 ## 总结 通过 Git 提交规范,可以提高代码的可读性和可维护性,方便项目的管理和协作开发。在实际开发中,需要遵循一定的提交规范,并且在提交信息中尽量详细地描述本次提交所做的修改。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值