Git 使用规范

Posted 2022-11-27 niaonao

分支命名

• master 分支
  • master 为主分支，也是用于部署生产环境的分支，master 分支要确保稳定性
  • master 分支一般由 develop 以及 hotfix 分支合并，任何时间都不能直接修改代码
• develop 分支
  • develop 为开发分支，始终保持最新完成以及bug修复后的代码
  • 一般开发新功能时，feature 分支都是基于 develop 分支下创建的
• feature 分支
  • 开发新功能时，以 develop 分支为基础创建 feature 分支
  • 分支命名: feature/ 开头的为特性分支， 命名规则: feature/module
• hotfix 分支
  • 分支命名: hotfix/ 开头的为修复分支，它的命名规则与 feature 分支类似
  • 线上出现紧急问题时，需要及时修复，以 master 分支为基线，创建 hotfix 分支，修复完成后，需要合并到 master 分支和 develop 分支
• release 分支
  • 分支命名: 标签版本分支，它的命名规则与 feature 分支类似
  • 基于master分支打分支，作为历史发版留存，便于回退版本或指定版本发版

注意事项

• 自己的分支一定要自测，切记不要提交后，影响到其他代码，更别说别人拉下代码还报错这种低级错误
• 本地分支要做到勤提交，分小功能提交，一次提交一大堆各种功能的做法也要杜绝
• 每天第一件事就是更新 develop 分支内容到本地分支，避免大规模 merge，太容易出错了
• 迭代新版本时，一定要保证当前开发分支和线上分支一样

提交规范

• EXPRESSION <type>(<scope>): <subject>
• type用于说明 commit 的类别
  • feat：新功能(feature)
  • fix：修补bug
  • docs：文档(documentation)
  • style： 格式(不影响代码运行的变动), 样式调整
  • refactor：重构(即不是新增功能，也不是修改bug的代码变动)
  • test: 增加测试
• scope用于说明 commit 影响的范围
• subject是 commit 目的的简短描述

示例：feat(定时任务):新增账单统计任务