Git 协同与提交规范

Git核心概念及原理

Git 是分布式版本控制系统，Git 的每个分支的管理类似于链表，每次提交都会产生一个 SHA1 的唯一标识符，此唯一标识符是引用的指针，后续的增删改查操作都可以基于这个指针进行索引操作。

关键字：分布式，四个分区，链表，SHA1指针

Git 四个工作区

Git 的文件操作原理都是基于 Workspace （工作区），Index / Stage （暂存区）, Repository （仓库区） 和 Remote（远程仓库）四个工作区来进行流转。

Workspace工作区： 平时存放编辑项目代码的空间

Index / Stage暂存区： 用于临时存放你的改动，事实上它只是一个文件，保存即将提交到文件列表信息

Repository仓库区（或版本库）： 就是安全存放数据的位置，这里面有你提交到所有版本的数据。其中 HEAD 指向最新放入仓库的版本

Remote远程仓库： 托管代码的服务器。例如 Github 的代码远端代码托管服务器

操作说明

1. pull 操作，Git 会从 远端仓库 到 工作区
2. fetch/clone 操作，Git 会从 远端仓库 到 版本仓库
3. add 操作，Git 会从 工作区 到 暂存区
4. commit 操作，Git 会从 暂存区 到 版本仓库

例如我们一次完整的提交 add --> commit --> push 经历的工作区变化就是

工作区 —> 缓存区 —> 本地仓库区 —> 远端仓库

Git分支管理

开发新功能或者修复 bug 之前，要用最新的 master 分支代码，拉新的分支，然后进行开发。git 分支命名规范如下：

• master 主干分支，当前正在运行的代码。不可直接往 master 提交代码。
• pre 预生产分支
• test 测试分支
• dev 开发分支，当前正在开发、但尚未发布的代码。不可直接往 dev 提交代码，但可以合并其他分支。
• feature-xxx 开发新功能
• fix-xxx bug 修复
• doc-xxx 仅修改文档，不修改代码

例如你要开发一个图片上传的功能，可以根据 master 分支拉一个新的分支 git checkout -b feature-upload-img
切忌遵守以上规范，不可乱来！！！

Git基本操作

$ git init  # 在当前目录新建一个 Git 代码库
$ git clone [url]  # 下载一个项目和它的整个代码历史
$ git config --list # 显示当前的 Git 配置
$ git config -e [--global]  # 编辑 Git 配置文件
$ git add  # 添加指定文件到暂存区
$ git rm   # 删除工作区文件，并且将这次删除放入暂存区
$ git commit -m [message]  # 提交暂存区到仓库区
$ git commit -a # 提交工作区自上次 commit 之后的变化，直接到仓库区
$ git commit --amend -m [message]   # 使用一次新的 commit，替代上一次提交 如果代码没有任何新变化，则用来改写上一次 commit 的提交信息
$ git commit --amend [file1] [file2] ...  # 重做上一次 commit，并包括指定文件的新变化
# 分支相关
$ git branch  # 列出所有本地分支
$ git branch -r  # 列出所有远程分支
$ git branch [branch-name]  # 新建一个分支，但依然停留在当前分支
$ git checkout [branch-name]  # 切换到指定分支，并更新工作区
$ git checkout -b [branch]  # 新建一个分支，并切换到该分支
$ git branch [branch] [commit]  # 新建一个分支，指向指定 commit
$ git checkout -b [branch] [tag]  # 新建一个分支，指向某个 tag
$ git branch --track [branch] [remote-branch]  # 新建一个分支，与指定的远程分支建立追踪关系
$ git branch --set-upstream [branch] [remote-branch]  # 建立追踪关系，在现有分支与指定的远程分支之间
$ git merge [branch]  # 合并指定分支到当前分支
$ git cherry-pick [commit]  # 选择一个 commit，合并进当前分支
$ git branch -d [branch-name]  # 删除分支
$ git push origin --delete [branch-name] # 删除远程分支
$ git branch -dr [remote/branch]  # 删除远程分支
# 标签
$ git tag  # 列出所有 tag
$ git tag [tag] # 新建一个 tag 在当前 commit
$ git tag [tag] [commit] # 新建一个 tag 在指定 commit
$ git show [tag]  # 查看 tag 信息
$ git push [remote] [tag]  # 提交指定 tag
$ git push [remote] --tags   # 提交所有 tag
# 查看
$ git status # 显示有变更的文件
$ git log # 显示当前分支的版本历史
$ git log --stat # 显示 commit 历史，以及每次 commit 发生变更的文件
$ git log --follow [file] # 显示某个文件的版本历史，包括文件改名
$ git log -p [file] # 显示指定文件相关的每一次 diff
$ git blame [file] # 显示指定文件是什么人在什么时间修改过
$ git diff # 显示暂存区和工作区的差异
$ git diff --cached [file] # 显示暂存区和上一个 commit 的差异
$ git diff HEAD # 显示工作区与当前分支最新 commit 之间的差异
$ git diff [first-branch]...[second-branch] # 显示两次提交之间的差异
$ git show [commit] # 显示某次提交的元数据和内容变化
$ git show --name-only [commit] # 显示某次提交发生变化的文件
$ git show [commit]:[filename] # 显示某次提交时，某个文件的内容
$ git reflog # 显示当前分支的最近几次提交
# 远程
$ git fetch [remote] # 下载远程仓库的所有变动
$ git remote -v  # 显示所有远程仓库
$ git remote show [remote]  # 显示某个远程仓库的信息
$ git remote add [shortname] [url]  # 增加一个新的远程仓库，并命名
$ git pull [remote] [branch]  # 取回远程仓库的变化，并与本地分支合并
$ git push [remote] [branch] # 上传本地指定分支到远程仓库
$ git push [remote] --force # 强行推送当前分支到远程仓库，即使有冲突
$ git push [remote] --all # 推送所有分支到远程仓库
# 撤销
$ git checkout [file] # 恢复暂存区的指定文件到工作区
$ git checkout [commit] [file] # 恢复某个 commit 的指定文件到工作区
$ git checkout . # 恢复上一个 commit 的所有文件到工作区
$ git reset [file] # 重置暂存区的指定文件，与上一次 commit 保持一致，但工作区不变
$ git reset --hard # 重置暂存区与工作区，与上一次 commit 保持一致
$ git reset [commit] # 重置当前分支的指针为指定 commit，同时重置暂存区，但工作区不变
$ git reset --hard [commit] # 重置当前分支的 HEAD 为指定 commit，同时重置暂存区和工作区，与指定 commit 一致
$ git reset --keep [commit] # 重置当前 HEAD 为指定 commit，但保持暂存区和工作区不变
$ git revert [commit] # 新建一个 commit，用来撤销指定 commit，后者的所有变化都将被前者抵消，并且应用到当前分支

Git高阶操作

merge, cherry-pick和patch使用及差别

多人协同开发中我们需要合并别人的代码（或者pick别人的部分代码），使本地分支代码达到理想最新状态。Git提供了三种合并的方式，后两者操作属于高阶操作，初学者很少知道如何使用以及他们的差别。

下图列举了三种操作的使用场景和差异，并且举例了具体操作实例。

删除 Git 缓存文件

场景： 有些情况开发者把原有不需要提交的代码提交到了远端仓库，再使用.gitignore忽略文件不生效。哪怕我们删除后再提交也没有办法忽略。这种情况下我们应该怎么解决？

方法： 我们可以使用git rm —cache 删除原来git跟踪的文件缓存，再在.gitignore里面添加忽略文件

## 当我们需要删除暂存区或分支上的文件, 同时工作区也不需要这个文件了, 可以使用
git rm file_path 
## 当我们需要删除暂存区或分支上的文件, 但本地又需要使用, 只是不希望这个文件被版本控制, 可以使用
# PS: file_path 为文件路径
git rm --cached file_path

如何强制提交

场景： 对于多人协作开发，有些时候我们会遇到版本管理混乱的情况，例如：远端版本错误了，但本地版本是正确的。 如何才能让强制更新远端版本，保持和本地工作区环境一样？

方法： 强制push本地正确的版本，但是慎用。因为它是不可逆转的。

# 强制更新，慎用
git push origin master --force

revert 和 reset区别

场景： 有些时候开发者需要退回到某次正确的提交记录，有些时候开发者的commit错误了，这时候可以使用 git revert 和 git reset。

• git revert： 撤销某次操作，此次操作之前的commit都会被保留。
• git reset ： 撤销某次提交，但是此次之后的修改都会被退回到暂存区。

# 强制回退到某次提交，且需要强制提交
git reset ——hard commit_hash 
git push origin master --force 
# 回退到某提提交，保存提交commit记录, 重新commit
git revert commit_hash
git add .
git commit -m "revert"
git push origin master

创建Tag，如何以某个Tag创建分支

有时我们代码已经发布很长时间才发现了一个Bug，同时当前开发分支又有需求在开发，如何以之前发布版本的节点开分支修复问题，这样就可以使用 Tag 创建分支。

# 创建tag
# 创建标注标签
git tag -a daily/0.0.1 -m "add develop file" 
# 简单创建tag
git tag daily/0.0.1                                 
# 分享tag到远端
git push origin [tagname]
git push origin --tags 
# 如何已某个tag创建分支
git checkout -b <newbranch> <tagname>

已某个远端分支为基础分支，创建本地分支

默认情况创建一个分支是以远端的 Master 分支为基础，本地创建一个 Master 分支。如果我们想直接远端某个分支为基础创建相应本地分支，可以如下操作， 或者想本地某个分支创建一个新分支，可以如下操作：

# 本地从当前所在分支上创建一个新分支： 
git checkout -b 新分支名 
# 拉取远程某个分支到本地: 
git checkout -b 本地分支名 origin/远程分支名

子模块（submodule）的使用场景

在复杂工程项目中，可能会遇到在一个 Git 仓库中添加其他 Git 仓库的场景，Submodule是仓库的一份引用。 下文会涉及到基于 lerna 多仓库管理的情况下，lerna 会去链接各个仓库的依赖关系，但是各个仓库又是独立的，那么就需要 submodule 进行管理，具体操作如下：

# 添加子模块
git submodule add 仓库地址
# 更新子模块
git submodule update --remote 模块名称
## 删除子模块
1. git rm --cached 模块名称
2. 删除 .gitmodules 下相应子模块信息
3. 删除 .git/config 下相应子模块信息

参考

github 秘籍 里面有一些奇技淫巧