Git 提交规范

Git Commit 规范

• Git commit message规范指提交注释时的编写规范，统一方便维护，如下：

feat:新功能

fix:修复一个bug

docs:只改了文档

style:修改不涉及代码的主要逻辑(如格式化了代码)

refactor:改动了代码，既不是新功能也不是修复bug

perf:优化了代码，提升了性能

test:增加或修改了代码测试

build:更改了构建流程相关的配置文件和包(如glup, npm)

ci:更改了CI配置文件或脚本等(如Travis, Circle, BrowserStack, SauceLabs)

chore:其它不涉及源代码和测试代码的修改

revert: git revert一次提交

Git分支使用规范

以下是一般情况的规则建议，适用于大多数场景。某些特定场景需要有所变通:

Git使用的工作流程

image.png

工作流程是指从创建、维护、提交、合并等开发的过程中的流程， 基本原则：线上默认有 master 和 develop 两个分支

• master 为受保护分支，所有人可以 clone 或者 pull ,仅指定人员可对master进行 push 和 merge
• develop 为日常开发分支

日常开发，从develop分支上 checkout 一个分支进行开发或者bug修复。分支命名规范：

• 分支版本命名规则：分支类型 分支发布时间功能。比如：feature_201704011859
• 分支类型包括：feature、 bugfix、refactor、hotfix四种类型，即新功能开发、bug修复、代码重构和紧急修复线上bug
• 时间使用年月日进行命名，不足2位补0，时间精确到分钟
• 分支功能命名使用snake case命名法，即下划线命名，可选
• 功能测试完毕，合并至 develop 分支，并将代码push到线上develop分支，定期进行codereview，待分支功能上线，删除开发分支
• 线上紧急bug，从master拉取hotfix分支； 修复完成后，合并回develop分支

.gitignore文件使用说明

一份用于忽略不必提交的文件的列表。统一的.ignore文件，减少不必要的文件提交和冲突，净化代码库环境。这里只需要根据实际的需求，统一就好。

/shelf/

/workspace.xml

/dataSources/

/dataSources.local.xml

/httpRequests/

global.iml

modules.xml

vcs.xml

.idea/*

.ignore文件不需要提交远程, 只需要本地保留就行.

Git状态模型

状态

涉及四个存储位置 工作区(workspace)、暂存区(Index)、本地仓库(local repository)、远程仓库(remote repository)

常用命令汇总

下面列了一些过程中经常使用到的命令，方便使用的时候查询

• 初始配置

git config --global user.name  "xxxxxx"

git config --global user.email "xxxxxx@qq.com"

• 克隆项目

git clone -b dev https://github.com/xxxxxx/xxxxxx.git

• 新增（将工作区文件添加到暂存区）

git add .

• 提交（把暂存区内容提交到当前分支）

git commit

• 本地内容提交到暂存区

git stash

• 本地内容从暂存区弹出来

git stash pop

• push （推送到远端develop分支）

git push origin develop

• 更新线上版本到本地

git pull

• 本地创建分支

git branch feature_202207160808

• 切换分支

git checkout feature_202207160808

• 将feature_202207160808分支合并到当前分支

git merge feature_202207160808

• 查看本地分支

git branch

• 查看远端分支

git branch -r

• 查看所有分支

git branch -a

• 本地分支推送到远端

git push origin feature_202207160808

• 删除远程分支

git push origin --delete feature_202207160808