前言
Git 是目前最流行的源代码管理工具。为规范开发,保持代码提交记录以及 git分支结构清晰,方便后续维护,总结了如下规范。
一、分支分类
Git主分支(保留分支):master、dev
主要分支:Master和Dev。前者用于正式发布,后者用于日常开发。
Git辅助分支(临时分支):feature、release、fix
除了常设分支以外,还有一些临时性分支,用于应对一些特定目的的版本开发。临时性分支主要有三种:
- 功能(feature)分支
- 预发布(release)分支
- 修补bug(fixbug)分支
这三种分支都属于临时性需要,使用完以后,应该立即删除,只留下Master和Dev。
命名格式: 类别 + / + 日期/迭代版本号/功能名称
例: feat/2.1.1
、fix/20201214
一些比较复杂的系统,需要子系统迭代的,就会用到功能名称,例:
feat/user_manage_1.1.1
、fix/user_manage_20201214
二、提交信息
常见的分类有下面几种:
build
:修改项目的的构建系统(xcodebuild、webpack、glup等)的提交ci
:修改项目的持续集成流程(Kenkins、Travis等)的提交chore
:构建过程或辅助工具的变化docs
:文档提交(documents)feat
:新增功能(feature)fix
:修复 bugpref
:性能、体验相关的提交refactor
:代码重构revert
:回滚某个更早的提交release
:发布新版本style
:不影响程序逻辑的代码修改、主要是样式方面的优化、修改test
:测试相关的开发improvement
:在现有功能上优化、改进
提交格式: 分类:具体描述信息(建议中文)
例:feat: 增加微信登录功能
、 fix: 修复微信定位不准确问题