Git使用规范

Git使用流程的规范.

目的: 避免杂乱无章的commit,从而让项目难以协调和维护。避免合并代码导致的丢失。

一.新建分支

每次开发新功能。都需要从最新的master新建分支。

1
2
3
4
5
6
# 获取主干最新代码
$ git checkout master
$ git pull

# 新建一个开发分支myfeature
$ git checkout -b myfeature

二.提交分支commit

分支功能开发修改后,就可以提交commit了。

1
2
3
$ git add --all   # 需要提交全部修改的话通过使用--all. 或者[git add .] 
$ git status
$ git commit --verbose

如果是commit指定的几个文件.

1
2
git status 查看变动的文件之后
git add ${需要提交的文件}

git add 只是将文件修改添加到了暂存区。git commit提交更改,是把暂存区的所有内容提交到当前分支。

Git工作区和暂存区

三.撰写提交信息

完整的功能开发,或者重要的修改迭代点给出完整扼要的提交信息。下面是一个范本

1
2
3
4
5
6
7
8
主题内容(一行不超过50字的提要)
罗列出改动原因、主要变动、以及需要注意的问题。

例如:

标黄公司GpsWifi策略需求开发
- 增加过滤大厂,增加过滤保险公司接口变量
- 增加命中标黄类型处理逻辑

简单的改动使用一行改动的主题说明即可。
格式可以是:

1
2
3
4
增加${什么内容}
修改${什么内容}
优化${什么内容}
修复${什么内容}

四.与主干同步

分支的开发过程中,要经常与主干保持同步。

1
2
$ git fetch origin
$ git rebase origin/master

五.合并commit

分支开发完成后,很可能有一堆commit,但是合并到主干的时候,往往希望只有一个(或最多两三个)commit,这样不仅清晰,也容易管理。

那么,怎样才能将多个commit合并呢?这就要用到 git rebase 命令。

1
$ git rebase -i origin/master