Git 规范

分支

目前项目代码采用简单分支模式来管理，原则上只保留 master、dev 两个分支。可根据实际需要创建临时分支，合并后及时删除。

• master：主分支，保持与线上版本一致。禁止在此分支直接修改提交代码，只接受其它分支合并。
• dev：开发分支，开发人员在此分支上进行新功能开发。
• fix：需要紧急修复线上问题时，从 master 创建 fix 分支。发布完成后同步合并到 dev 分支，及时删除。
• 其它：功能、特性实验性质的分支，合并后需要及时删除。

提交描述

提交描述信息需要按指定格式编写，格式为 分类: 描述信息。

1. 分类用于说明本次提交内容的类别，只允许使用下面 7 个标识：

   • feat：新功能（feature）
   • fix：修补bug
   • docs：文档（documentation）
   • style： 格式（不影响代码运行的变动）
   • refactor：重构（即不是新增功能，也不是修改bug的代码变动）
   • test：增加测试
   • chore：构建过程或辅助工具的变动，例如：更新依赖库

   提示

   feat 和 fix 使用易混淆问题，可根据提交代码的用途来判断是使用 feat 还是 fix，如果本次提交是为了实现或者扩展细化某个需求，应使用 feat，否则应使用 fix。

2. 描述信息 是本次提交内容的简短描述。

   • 内容描述建议格式：定位信息+动词+提交内容概述
   • 定位信息：功能模块/页面，用于描述提交代码的改动位置及影响范围
   • 动词：增加/完成/修改/修复/删除等
   • 提交内容概述：清晰准确概述提交内容，应合理使用标点符号断句

3. 注意事项

   • 禁止一次提交大量不相关变动，应分别提交并描述。
   • 禁止相同注释多次提交
   • 禁止使用无实际内容的空泛描述