您必须知道的 Git 分支开发规范，附 Git 常用命令大全！

我们都知道，阿里有 Java 规范，Redis 规范，而 Git 规范几乎从未被聊起，所以，今天我就说一说 Git 的日常分支开发规范。

先说分支命名规范。

master 分支：master 为主分支，也是用于部署生产环境的分支，确保 master 分支稳定性；master 分支一般由 develop 以及 hotfix 分支合并，任何时间都不能直接修改代码。

develop 分支：develop 为开发分支，始终保持最新完成以及 bug 修复后的代码；一般开发的新功能时，feature 分支都是基于 develop 分支下创建的。

feature 分支：开发新功能时，以 develop 为基础创建 feature 分支；分支命名以 feature/ 开头的为特性分支，命名规则 feature/user_module、 feature/cart_module。

release 分支：release 为预上线分支，发布提测阶段，会 release 分支代码为基准提测。

当有一组 feature 开发完成，首先会合并到 develop 分支，进入提测时，会创建 release 分支。如果测试过程中若存在 bug 需要修复，则直接由开发者在 release 分支修复并提交。当测试完成之后，合并 release 分支到 master 和 develop 分支，此时 master 为最新代码，用作上线。

hotfix 分支：分支命名以 hotfix/ 开头的为修复分支，它的命名规则与 feature 分支类似；线上出现紧急问题时，需要及时修复，以 master 分支为基线，创建 hotfix 分支，修复完成后，需要合并到 master 分支和 develop 分支。

使用 Git 添加新功能的示例如下：

(dev)$: git checkout -b feature/xxx  # 从dev建立特性分支  (feature/xxx)$: blabla  # 开发  (feature/xxx)$: git add xxx  (feature/xxx)$: git commit -m 'commit comment'  (dev)$: git merge feature/xxx --no-ff  # 把特性分支合并到dev

修复紧急 bug 示例：

(master)$: git checkout -b hotfix/xxx  # 从master建立hotfix分支  (hotfix/xxx)$: blabla  # 开发  (hotfix/xxx)$: git add xxx  (hotfix/xxx)$: git commit -m 'commit comment'  (master)$: git merge hotfix/xxx --no-ff # 把hotfix分支合并到master，并上线到生产环境  (dev)$: git merge hotfix/xxx --no-ff  # 把hotfix分支合并到dev，同步代码

测试环境合并示例： 

(release)$: git merge dev --no-ff  # 把dev分支合并到release，然后在测试环境拉取并测试

线上生产环境操作示例： 

(master)$: git merge release --no-ff  # 把release测试好的代码合并到master，运维人员操作  (master)$: git tag -a v0.1 -m '部署包版本名'  #给版本命名，打Tag

提交日志规范：在一个团队协作的项目中，开发人员需要经常提交一些代码去修复 bug 或者实现新的 feature。而项目中的文件和实现什么功能、解决什么问题都会渐渐淡忘，最后需要浪费时间去阅读代码。但是好的日志规范 commit messages 编写有帮助到我们，它也反映了一个开发人员是否是良好的协作者。

编写良好的 Commit messages 可以达到3个重要的目的：

  • 加快 review 的流程
  • 帮助我们编写良好的版本发布日志
  • 让之后的维护者了解代码里出现特定变化和 feature 被添加的原因

目前，社区有多种 Commit message 的写法规范。来自 Github 上的 Angular 规范是目前使用最广的写法，比较合理和系统化。如下图：

Commit messages 的基本语法规范。

当前业界应用的比较广泛的是 Angular Git Commit Guidelines，

具体格式为:

<type>: <subject>  <BLANK LINE>  <body>  <BLANK LINE>  <footer>
  • type: 本次 commit 的类型，诸如 bugfix docs style 等
  • scope: 本次 commit 波及的范围
  • subject: 简明扼要的阐述下本次 commit 的主旨，在原文中特意强调了几点 1. 使用祈使句，是不是很熟悉又陌生的一个词，来传送门在此 祈使句 2. 首字母不要大写 3. 结尾无需添加标点
  • body: 同样使用祈使句，在主体内容中我们需要把本次 commit 详细的描述一下，比如此次变更的动机，如需换行，则使用 |
  • footer: 描述下与之关联的 issue 或 break change。

Type的类别说明：

  • feat: 添加新特性
  • fix: 修复 bug
  • docs: 仅仅修改了文档
  • style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
  • refactor: 代码重构，没有加新功能或者修复 bug
  • perf: 增加代码进行性能测试
  • test: 增加测试用例
  • chore: 改变构建流程、或者增加依赖库、工具

Commit messages 格式要求。

# 标题行：50个字符以内，描述主要变更内容  #  # 主体内容：更详细的说明文本，建议72个字符以内。需要描述的信息包括:  #  # * 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，  # 提升性能、可靠性、稳定性等等  # * 他如何解决这个问题? 具体描述解决问题的步骤  # * 是否存在副作用、风险?  #  # 如果需要的化可以添加一个链接到issue地址或者其它文档

最后列举一些我们团队人手打印一份的 Git 常用命令清单。

新建代码库常用命令。 

# 在当前目录新建一个Git代码库  $ git init  # 新建一个目录，将其初始化为Git代码库  $ git init [project-name]  # 下载一个项目和它的整个代码历史  $ git clone [url]

Git 的设置文件为 .gitconfig，它可以在用户主目录下（全局配置），也可以在项目目录下（项目配置）。

# 显示当前的Git配置  $ git config --list  # 编辑Git配置文件  $ git config -e [--global]  # 设置提交代码时的用户信息  $ git config [--global] user.name "[name]"  $ git config [--global] user.email "[email address]"

增加/删除文件命令。

# 添加指定文件到暂存区  $ git add [file1] [file2] ...  # 添加指定目录到暂存区，包括子目录  $ git add [dir]  # 添加当前目录的所有文件到暂存区  $ git add .  # 添加每个变化前，都会要求确认  # 对于同一个文件的多处变化，可以实现分次提交  $ git add -p  # 删除工作区文件，并且将这次删除放入暂存区  $ git rm [file1] [file2] ...  # 停止追踪指定文件，但该文件会保留在工作区  $ git rm --cached [file]  # 改名文件，并且将这个改名放入暂存区  $ git mv [file-original] [file-renamed]

代码提交命令。 

# 提交暂存区到仓库区  $ git commit -m [message]  # 提交暂存区的指定文件到仓库区  $ git commit [file1] [file2] ... -m [message]  # 提交工作区自上次commit之后的变化，直接到仓库区  $ git commit -a  # 提交时显示所有diff信息  $ git commit -v  # 使用一次新的commit，替代上一次提交  # 如果代码没有任何新变化，则用来改写上一次commit的提交信息  $ git commit --amend -m [message]  # 重做上一次commit，并包括指定文件的新变化  $ git commit --amend [file1] [file2] ...

分支管理命令。 

# 列出所有本地分支  $ git branch  # 列出所有远程分支  $ git branch -r  # 列出所有本地分支和远程分支  $ git branch -a  # 新建一个分支，但依然停留在当前分支  $ git branch [branch-name]  # 新建一个分支，并切换到该分支  $ git checkout -b [branch]  # 新建一个分支，指向指定commit  $ git branch [branch] [commit]  # 新建一个分支，与指定的远程分支建立追踪关系  $ git branch --track [branch] [remote-branch]  # 切换到指定分支，并更新工作区  $ git checkout [branch-name]  # 切换到上一个分支  $ git checkout -  # 建立追踪关系，在现有分支与指定的远程分支之间  $ git branch --set-upstream [branch] [remote-branch]  # 合并指定分支到当前分支  $ git merge [branch]  # 选择一个commit，合并进当前分支  $ git cherry-pick [commit]  # 删除分支  $ git branch -d [branch-name]  # 删除远程分支  $ git push origin --delete [branch-name]  $ git branch -dr [remote/branch]

标签操作命令。 

# 列出所有tag  $ git tag  # 新建一个tag在当前commit  $ git tag [tag]  # 新建一个tag在指定commit  $ git tag [tag] [commit]  # 删除本地tag  $ git tag -d [tag]  # 删除远程tag  $ git push origin :refs/tags/[tagName]  # 查看tag信息  $ git show [tag]  # 提交指定tag  $ git push [remote] [tag]  # 提交所有tag  $ git push [remote] --tags  # 新建一个分支，指向某个tag  $ git checkout -b [branch] [tag]

查看一些信息的常用命令。 

# 显示有变更的文件  $ git status  # 显示当前分支的版本历史  $ git log  # 显示commit历史，以及每次commit发生变更的文件  $ git log --stat  # 搜索提交历史，根据关键词  $ git log -S [keyword]  # 显示某个commit之后的所有变动，每个commit占据一行  $ git log [tag] HEAD --pretty=format:%s  # 显示某个commit之后的所有变动，其"提交说明"必须符合搜索条件  $ git log [tag] HEAD --grep feature  # 显示某个文件的版本历史，包括文件改名  $ git log --follow [file]  $ git whatchanged [file]  # 显示指定文件相关的每一次diff  $ git log -p [file]  # 显示过去5次提交  $ git log -5 --pretty --oneline  # 显示所有提交过的用户，按提交次数排序  $ git shortlog -sn  # 显示指定文件是什么人在什么时间修改过  $ git blame [file]  # 显示暂存区和工作区的差异  $ git diff  # 显示暂存区和上一个commit的差异  $ git diff --cached [file]  # 显示工作区与当前分支最新commit之间的差异  $ git diff HEAD  # 显示两次提交之间的差异  $ git diff [first-branch]...[second-branch]  # 显示今天你写了多少行代码  $ git diff --shortstat "@{0 day ago}"  # 显示某次提交的元数据和内容变化  $ 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]  # 恢复某个commit的指定文件到暂存区和工作区  $ git checkout [commit] [file]  # 恢复暂存区的所有文件到工作区  $ git checkout .  # 重置暂存区的指定文件，与上一次commit保持一致，但工作区不变  $ git reset [file]  # 重置暂存区与工作区，与上一次commit保持一致  $ git reset --hard  # 重置当前分支的指针为指定commit，同时重置暂存区，但工作区不变  $ git reset [commit]  # 重置当前分支的HEAD为指定commit，同时重置暂存区和工作区，与指定commit一致  $ git reset --hard [commit]  # 重置当前HEAD为指定commit，但保持暂存区和工作区不变  $ git reset --keep [commit]  # 新建一个commit，用来撤销指定commit  # 后者的所有变化都将被前者抵消，并且应用到当前分支  $ git revert [commit]  # 暂时将未提交的变化移除，稍后再移入  $ git stash  $ git stash pop

生成发布包命令。 

# 生成一个可供发布的压缩包  $ git archive

以上，你知道的越多，不知道的就越多，业余的像一棵小草一样。

VirMach 便宜 VPS

QNews

QNews