✅ Git 团队协作使用说明文档
📌 目录
-
一、Git 简介
-
二、初始配置(全员必设)
-
三、项目初始化与克隆(首次使用)
-
四、团队协作流程建议
-
五、文件操作与提交规范
-
六、查看状态与日志
-
七、分支协作与合并
-
八、远程仓库操作规范
-
九、标签发布与版本管理
-
十、常用回退与恢复命令
-
十一、推荐配置汇总
-
十二、常见问题与建议
一、Git 简介
Git 是一个分布式版本控制系统,每个开发者的本地仓库都完整保存了代码的所有历史版本,可在离线环境中提交/查看历史/创建分支等操作。
-
支持多人并行开发,功能分支协作
-
可与 GitHub、GitLab、Gitee 等远程仓库协同使用
-
高效支持代码合并、冲突管理、版本发布
二、初始配置(全员必设)
目的:确保提交记录能清晰追踪责任人。
bash复制编辑# 设置用户名(请使用真实姓名/工号,统一格式如:张三-1001)
git config --global user.name "张三-1001"
# 设置企业邮箱(或GitHub邮箱)
git config --global user.email "zhangsan@example.com"
# 查看当前所有配置
git config --list
✅ 建议统一格式:有助于日志追溯
三、项目初始化与克隆(首次使用)
建议统一从远程主仓库克隆,避免不必要的初始化。
bash复制编辑# 初始化本地仓库(仅用于创建新项目)
git init
# 从远程仓库克隆项目
git clone https://github.com/yourteam/project.git
# 进入项目目录
cd project
📌 注意:
-
克隆项目时默认创建
origin
远程地址 -
克隆后请立即切换到工作分支开发,不要直接在
main
上开发
四、团队协作流程建议
✅ 推荐协作流程
bash复制编辑# 切换并更新主分支
git checkout main
git pull origin main
# 创建并切换到新分支
git checkout -b feature/登录功能
# 本地提交更改
git add .
git commit -m "feat: 登录页面开发完成"
# 推送新分支到远程仓库
git push origin feature/登录功能
📌 提交完成后:
-
登录 GitHub/GitLab 创建合并请求(PR/MR)
-
指定目标分支(如:main / develop)
-
说明变更内容
-
通知代码审核人
-
审核通过后方可合并
🚫 切勿直接 push 到主分支!
五、文件操作与提交规范
提交规范
bash复制编辑git add 文件名 # 添加指定文件 git add . # 添加全部更改 git commit -m "feat: 新增注册接口" git commit -am "fix: 修复接口异常返回值"
✅ 提交信息格式建议(Conventional Commits)
类型 | 描述 |
---|---|
feat | ✨ 新功能 |
fix | 🐛 修复 Bug |
docs | 📝 文档更新 |
style | 💄 代码格式(无功能变更) |
refactor | ♻️ 代码重构(非修复/新功能) |
chore | 🔧 构建流程/工具变更等 |
test | ✅ 添加测试 |
📌 避免提交信息为 "update", "fix bug" 等模糊词语。
六、查看状态与日志
bash复制编辑git status # 查看当前工作区状态
git log # 查看提交历史
git log --oneline # 简洁视图
git diff # 查看当前改动
git diff --cached # 查看暂存区改动
✅ 建议常用组合:
bash
复制编辑
git log --oneline --graph --decorate --all
可直观查看分支合并历史图。
七、分支协作与合并
bash复制编辑git branch # 查看所有本地分支
git checkout -b feature/a # 创建并切换新分支
git merge feature/a # 合并分支到当前分支
git branch -d feature/a # 删除已合并的分支
🧠 多人协作建议:
-
每人一功能一分支,命名如:
-
feature/login
-
fix/button-style
-
-
合并前:确保拉取主干最新代码
bash 复制编辑 git pull origin main
-
遇到冲突:用工具(如 VS Code)辅助解决,完成后提交
八、远程仓库操作规范
bash复制编辑git remote -v # 查看远程仓库地址
git pull origin develop # 拉取 develop 分支并合并
git fetch origin # 获取远程更新但不自动合并
git push origin feature/login # 推送分支
git push -u origin feature/login # 首次推送并设置默认上游
📌 推送前务必更新代码,避免非快进冲突(non-fast-forward)
九、标签发布与版本管理
bash复制编辑git tag v1.0.0 # 创建轻量标签
git tag -a v1.1.0 -m "Release v1.1.0" # 创建带说明标签
git push origin v1.1.0 # 推送标签
git tag -d v1.0.0 # 删除标签(本地)
✅ 建议版本号规则:
复制编辑
v主版本号.次版本号.修订号(例:v2.3.1)
配合 changelog 使用,提升版本可追溯性。
十、常用回退与恢复命令
bash复制编辑git checkout -- 文件名 # 撤销修改
git reset HEAD 文件名 # 取消已 add 的文件
git reset --soft HEAD^ # 回退上一次提交,保留更改
git reset --hard HEAD^ # 回退并丢弃更改(危险)
git clean -fd # 删除未跟踪的文件(慎用)
📌 使用 reset --hard
和 clean -fd
前务必备份或确认无误
十一、推荐配置汇总(统一配置建议)
bash复制编辑git config --global init.defaultBranch main
git config --global merge.conflictstyle diff3
git config --global core.editor "code --wait"
git config --global color.ui auto
git config --global push.default simple
🔧 推荐使用 .gitignore
统一忽略文件,如 .DS_Store
, node_modules/
, __pycache__/
等。
十二、常见问题与建议
❓ Q1:提交后没生效?
✅ 检查是否漏执行 git add 文件
❓ Q2:push 报错(non-fast-forward)?
✅ 远程已有更新,先执行:
bash
复制编辑
git pull --rebase origin main
❓ Q3:冲突如何解决?
-
查看冲突文件
bash
复制编辑
git status
-
修改文件冲突标记区(如 <<<< HEAD)
-
保存并
git add 文件
-
提交合并
git commit
❓ Q4:多人改同一文件怎么办?
-
避免直接改 main/develop
-
使用功能分支,及时合并主干
-
减少提交粒度冲突风险
Git 命令使用说明文档
📌 目录
Git 简介
Git 是一个分布式版本控制系统,用于跟踪文件的变更,协作开发项目。
Git 配置
bash复制编辑# 设置用户名
git config --global user.name "你的名字"
# 设置邮箱
git config --global user.email "你的邮箱@example.com"
# 查看当前配置
git config --list
Git 项目初始化与克隆
bash复制编辑# 初始化本地仓库
git init
# 克隆远程仓库
git clone https://github.com/username/repo.git
文件操作
bash复制编辑# 查看文件状态
git status
# 添加指定文件到暂存区
git add 文件名
# 添加所有改动的文件
git add .
# 提交暂存区内容
git commit -m "提交信息"
# 同时添加和提交改动
git commit -am "直接提交"
查看状态和日志
bash复制编辑# 查看提交历史
git log
# 单行显示历史
git log --oneline
# 查看文件修改内容
git diff
# 比较暂存区与最新提交
git diff --cached
分支操作
bash复制编辑# 创建新分支
git branch 分支名
# 切换分支
git checkout 分支名
# 创建并切换分支
git checkout -b 分支名
# 合并其他分支
git merge 分支名
# 删除本地分支
git branch -d 分支名
远程操作
bash复制编辑# 查看远程仓库地址
git remote -v
# 添加远程仓库
git remote add origin https://github.com/username/repo.git
# 推送到远程仓库
git push -u origin 分支名
# 拉取远程仓库内容
git pull origin 分支名
# 获取远程更新(不合并)
git fetch origin
标签管理
bash复制编辑# 创建标签
git tag v1.0
# 带说明的标签
git tag -a v1.0 -m "版本1.0"
# 查看所有标签
git tag
# 推送标签到远程
git push origin v1.0
# 删除标签
git tag -d v1.0
撤销与回退
bash复制编辑# 撤销对文件的修改(恢复到最近一次提交)
git checkout -- 文件名
# 取消暂存区的文件
git reset HEAD 文件名
# 回退到上一个提交(保留修改)
git reset --soft HEAD^
# 回退到上一个提交(不保留修改)
git reset --hard HEAD^
常用配置命令汇总
bash复制编辑# 设置默认主分支为 main(可选)
git config --global init.defaultBranch main
# 合并时自动展开冲突
git config --global merge.conflictstyle diff3
# 设置默认文本编辑器
git config --global core.editor "code --wait" # VS Code
📘 附录:常见问题
-
❓ Git commit 不生效? 请确认是否已使用
git add
添加了文件。 -
❓ 推送失败(non-fast-forward)? 尝试
git pull --rebase
后再推送。