【HelloKitty团队】Git规范

完整开发流程的Git规范

1. 创建个人开发分支

1.1 明确分支对应的issues

issues在coding平台中对应【项目协同】中的需求/任务/缺陷，以下简称 issues。

建分支之前先浏览【项目协同】中有没有这个分支要解决的问题的issues：

• 如果存在并且无人认领，请将此issues的负责人标记给自己，代表认领此任务并占有此ID纳入分支名，避免分支名重复带来的拉取冲突隐患；
• 否则请创建新任务，并分配给自己作为标识，将任务ID加入分支名中。

1.2 分支名规范

• 分支名应当按顺序包含以下信息，使用符号-连接：

  • 分支类型，选择feat|fix|docs|style|refactor|test|chore|ci其一

  • 个人名字缩写

  • issues【即项目协同中的需求/任务/缺陷ID】的标号。

    注：如果分支对应多个issues，在pr的merge message中逐一关联即可，详见【4. pull request 规范】。分支名只需包含一个issuesID.

  • 【可选】如果有必要或者你喜欢，可以追加基本信息描述；否则在pr的merge message中具体描述分支解决的问题即可，详见【4. pull request 规范】

• 其中前三项为必需信息，合理的分支名如：

  # 功能分支，对应issues #6
  feat-lzh-6
  
  # 修复分支，对应issues#18
  fix-lzh-18-hotfix-fatal-error
  

• 错了也没关系不用remake，下次注意即可。

• 发现其他成员分支名不合规范请及时友善提醒，帮ta避免分支名重复可能带来的git冲突隐患

1.3 分支拉取指令

git checkout dev
git pull origin dev		# 同步最新的远程dev分支
git checkout -b standard_branch_name origin/dev

【注意】请务必注意建立新分支前，保证本地dev分支已经同步最新的远程dev分支

• 如果忘记基于最新的dev分支拉取并且已经开发了一段时间了，按照【4. 本地rebase解决冲突】流程及时rebase就行

【说明】：

• 本项目已经将dev分支设置为default分支，默认创建分支git branch -b new_branch及发送pr的目标分支，都是基于default分支。

• 如果想基于非default的分支创建分支，请使用 git branch -b new_branch origin/non-default_branch。建议养成这个好习惯，基于default分支创建新分支时也用origin/dev来指明拉取分支

1.4 分