Git 新建分支和Commit Message 规范和最佳实践
为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,现规范 git 的相关操作
文章目录
Git 分支命名规范
git 分支分为集成分支、功能分支和修复分支,分别命名为 develop、feature 和 hotfix,均为单数。不可使用
features、future、hotfixes、hotfixs等错误名称
-
master
主分支,永远是可用的稳定版本,不能直接在该分支上开发
-
develop
开发主分支(集成分支),所有新功能以这个分支来创建自己的开发分支,该分支只做只合并操作,不能直接在该分支上开发
集成分支分为两种:
-
版本内的集成分支(命名规范)
feature/versions/{$version}
-
所有功能的集成分支(命名规范)
develop
-
-
feature-xxx
功能开发分支,在develop上创建分支,以自己开发功能模块命名,功能测试正常后合并到develop分支
功能分支分为两类:
-
版本功能分支(命名规范)
feature/{date}_{$version}/{$Issue_id}_{$description}
-
非版本功能分支,不跟版本一起上线的功能或者一些不紧急的 bugs。(命名规范)
feature/{$username}/{$issue_id}_{$description}
注意:
-
变量 $version 代表版本号,格式为 vx_x_x(x为数字),比如 v6_5_0
-
变量 $issue_id 代表 JIRA 的 Issue ID,或者 TAPD#ID,比如PT-7、TAPD#1011729
-
变量 $username 代表开发者。username 统一使用各个 developer 的公司邮箱账号,比如 zhuangsq,liangzy
-
变量 $description 代表分支功能描述。应该尽量用简短的词组描述,不能使用中文,
-