Git 代码管理规范
提交消息
优先推荐使用 gitmoji,可以更直观地看到提交的类型。vscode 中可以安装 Gitmoji 插件,在每次提交时点击笑脸图标选择一个表情符号。能直接弹出一个框看到每个表情符号的含义。非常方便。
如果不使用 gitmoji,提交消息格式如下:使用美式英文,方便开源
格式:<type>(<scope>): <subject>
,一个都不能漏
类型 | 描述 |
---|---|
feat | 新功能 |
fix | 修复 |
chore | 不改功能,比如写文档(文档项目除外)、更新依赖 |
release | 由 CI 发布的版本 |
refactor | 重构 |
特殊提交消息:
init the project
:代表项目刚刚创建和初始化 git 仓库
分支名
分支名称 | 用途 |
---|---|
master | 主分支,用于发布稳定版本 |
develop | 开发分支,用于开发新功能 |
<type>/<subject> | 功能分支,用于开发新功能 |
v<version> | 版本分支,用于备份旧版本 |
next | 预发布分支,用于测试新功能 |
项目名
项目名使用小写字母+hyphen,如 my-project
、swesome-project
仓库名
仓库名=项目名+hyphen+版本,如 my-project
、awesome-project-v2
也有可能是多平台的名字
仓库名=项目名+hyphen+平台名,如 visual-file-qt
、visual-file-vscode
如果是既有平台又有版本,平台名放在前面。