代码提交规范说明

代码提交说明

gitHook

代码提交会经过lint-staged审核。所有不能通过eslint检查的代码将会commit失败

请各位保证代码的clean。确保不会把💩提交到仓库中

提交注释

代码提交的注释(msg)需要统一进行规范前缀,方便一眼看出这个提交做了哪些事

目前的前缀有

  1. 「add」XX模块

  2. 「update」XX调整

  3. 「fix」XXbug修复

  4. 「remove」移除XX

希望大家提交代码时遵守规范,让我们的git tree看上去也干净整洁

image.png

我们会使用commitizen工具来规范提交的message。

具体步骤为:

  1. git pull –rebase 先将远程仓库最新版本代码拉取到本地工作区(–rebase是为了让git tree整洁,避免冲突,参考文章);
  2. git add . 将当前工作区的修改全部提交到暂存区;
  3. yarn commit 选择提交类型(按键盘方向键选择,回车确定); image.png
  4. 输入对当前提交的说明注释(按回车开始commit);
    image.png
  5. commit成功之后,git push推送到远端仓库即可完成提交。

    image.png

分支管理

master分支作为发布分支

dev分支作为开发分支

从master检出dev分支,从dev检出feature分支

快速迭代分支命名为 feature/XX(功能名字)

所有的hot-fix和发布版本号都需要打tag

快速迭代的分支在发布前需要合并到dev分支,dev分支在发布前需要合并到master分支,所有合并需要使用merge来确保在git tree上的版本清晰

示意图如下:git分支管理示意图.png

提交规则

提交时不宜一次修改和提交过多文件,可以现在本地开个分支分多次提交,后面进行rebase

  1. 防止lint-staged审核过不去导致回头改很多文件很痛苦

  2. codereview困难

非版本合并以及主分支合并情况下,请使用git pull –rebase 避免污染git tree

日常合并请不要使用merge,记得commit之前先git pull –rebase

具体区别

不要使用git push -f

具体原因

生命诚可贵,且行且珍惜

代码千万行,注释第一行,注释不规范,同事两行泪

github地址
https://github.com/liujians/git-normalize