git使用规范

一、分支规范

在开发过程中,一般会存在以下几种分支:
main分支(master)
master为主分支,也是用于部署生产环境的分支,一般由 dev 以及 fixbug分支合并,任何时间都不能直接修改代码。
dev分支
develop 为开发分支,始终保持最新完成以及bug修复后的代码。一般开发新功能时,feature 分支都是基于 dev 分支下创建的。
feature-[功能名称/版本信息]
feature为需求分支,以 dev 分支为基础创建 feature 分支。每个开发人员基于feature分支,创建自己的开发分支。
fixbug-[bug编号]
线上出现紧急问题时,需要及时修复,以 master 分支为基线,创建 fixbug分支,修复完成后,需要合并到 master 分支和 dev 分支。

二、Commit 提交规范

2.1 提交的日志格式

每次git提交日志格式为: 类型:描述
  • 类型
  • 用于说明 commit 的类别,只允许使用下面7个标识。
    • feat:新功能
    • fix:修补bug
    • docs:修改文档
    • style: 格式化代码结构,没有逻辑上的代码修改
    • refactor:重构,即不是新增功能,也不是修改bug的代码变动,比如重命名变量
    • test:增加测试代码,单元测试一类的,没有生产代码的变更
    • chore:构建过程或辅助工具的变动(不会影响代码运行)

2.2 更新、合并规范

原则:
① 下游分支更新上游分支代码用rebase
② 上游分支合并下游分支代码用merge
③ 更新本分支代码用--rebase (如果本分支有多人共同使用开发的时候);
这样可以消除自动产生的无用merge记录,有利于后续查看开发记录。
下游分支在更新上游分支代码的时候,如果使用merge,会产生一条无用的合并记录,比较影响查看历史,使用rebase则不会。
 
链接:https://juejin.cn/post/7049728943716302878
点赞

当前页面评论已关闭。

隐藏
变装