Git 的正确使用姿势与最佳实践:团队协作和版本控制的最佳实践 | 青训营

204 阅读5分钟

GIT初始配置

在cmd下

git config --global user.name “提交人姓名”

git config --global user.email “提交人邮箱”

姓名可以是拼音缩写,只有这样才能知道是谁提交的

邮箱与github账号邮箱保持一致

使用git config --list 查看是否设置成功

goland配置

在goland的Settings->version control-Git 配置git的路径

goland的Settings->version control-Github,登录github账号。如果登陆不上,需要在github上设置token登陆

配置 SSH

windows任意一文件夹下,右键选 git bash here打开git终端

在git终端下

ssh-keygen -t ed25519 -C github邮箱账号

image.png

之后敲三次回车

cd ~/.ssh

ls

cat id_ed25519.pub

在github上,点头像,setting,SSH,创建ssh

Title随便写,Key写刚刚.pub的内容

将仓库的 main 分支拉取到本地 打开仓库网页,点击code

image.png

在cmd/ gitbash 下,cd到放项目的目录,然后clone项目,clone后会自动创建一个testgit文件夹

  1. (推荐)通过 SSH

` git clone ssh地址

  1. 通过 HTTPS

切换到 develop 分支查看代码

用goland/vscode打开testgit文件夹,在Terminal选项卡下敲命令

git checkout develop

main分支 用于最终稳定的大版本,前期不用管这个分支

develop分支 为项目目前正在开发的版本,只开发了部分功能,不过已开发的功能通过了简单的测试

创建自己的分支:使用命令git branch branch_name创建一个新的分支

branch_name建议取名为"dev-姓名拼音缩写"(在一开始不确定要开发什么功能的时候)或“dev-某个功能模块” eg. dev-redis

基本流程

使用goland或vscode自带的git功能会比命令方便,基本流程和命令操作是一样的

先知道命令的大致流程,然后用后面写的IDE操作

  1. 切换自己的分支:

使用命令git checkout branch_name切换到自己的分支。 eg.git checkout dev-xxx

git checkout -b name命令为创建并切换到对应的分支,包括了branch)

  1. 开发代码:在该分支下进行Golang代码开发。
  2. add文件:

使得git能够跟踪这些文件,只有add的这些文件会作为git的一个版本

使用命令添加多个文件 git add file1 file2 file3 或 git add *.go,file是要添加的文件名

添加单个 git add file_name

后面还可以继续开发修改代码,最后在提交前把需要的文件都add了

  1. 提交版本:开发的几个小功能经过测试没有bug,commit提交为小版本

使用命令git commit -m "版本提交信息"提交更改到本地仓库

版本提交信息需要遵循我文档后面写的commit规范

  1. 推送到远程仓库:使用命令git push origin 分支名

git push origin dev-xxx将本地分支推送到远程仓库。

在自己的分支内可以随便玩,修改或推送自己的分支不会影响到正在开发的develop分支

总结:确保在自己的分支内开发->编写代码->将需要的文件add->commit提交并推送

IDE 操作(推荐)

Checkout:

在IDE右下角可以New Branch新建分支

并查看当前属于哪个分支

要切换分支就选中对应的分支Checkout

当前的分支会有这样的图标

切换分支时会有这样的提示,可以无视,如果不想看见这样的提示,点弹出框的设置图标,选择No popup

点git选项卡,点log,左侧区域为分支区,右侧区域为当前分支的各个版本

在左侧区域的双击一个分支,查看右侧区域该分支的版本。然后在左侧选中的分支右键点checkout切换过去

在右侧区域可以切换当前该分支的不同commit版本。当前正在查看的版本会有黄色图标

add操作

选中要add的多个文件,或选中目录,右键Git->add

文件绿色的表示已add,红色的表示未add

当commit版本提交完成后,文件再次被修改时变成蓝色,表示被追踪过并修改

Commit、 Push 、Pull、 Clone IDE 上面的Git

将自己开发的代码放到develop分支

  1. 切换到develop分支:命令git checkout develop
  2. 更新develop分支:每次先从远程仓库获取他人写的最新代码

命令git pull origin develop进行代码更新

  1. 合并分支:git merge dev-xxx 将指定分支合并到当前分支,将dev-xxx合并到develop

  2. 解决代码冲突:自己写的代码可以自行解决冲突并手动修改代码,如果是他人写的在群里交流看保留哪个代码

  3. 推送合并后的代码:使用命令git push origin develop将合并后的代码推送到远程仓库。

  4. 切换回自己的分支 git checkout dev-xxx

总结:切换要合并到的分支->更新开发分支->合并指定分支到当前分支->解决冲突后推送->回到自己的分支继续开发

merge的IDE 操作

先切换到develop分支,然后pull更新develop分支,然后选择要合并的分支到develop

或者点IDE上面的Git-Merge

git 提交规范

在网上有很多git提交规范,遵循自己团队的开发规范即可。一般都是动词开头 然后后面写具体提交的内容 如Update xxx Add xxx Fix xxx

其他

切换分支前,如果当前分支文件有add或修改操作,当前分支一定需要commit后再切换分支,避免对git不了解导致的文件错乱

如果此时就想查看别的分支代码,可以不用checkout切换就能查看对应版本代码,先在git log左侧双击某个分支(不要右键点checkout),选择一个版本,右键show repository

如果自己的dev-xxx分支已经开发的比较乱,又想重新基于develop开发并更新代码

就先git checkout develop 回到develop分支,之后创建并进入一个新的分支,然后开发代码

如果goland commit时卡在了committing

把commit里这个选项关掉

在github网页查看代码需选择对应的分支