Git 使用文档

Git中文文档 Git中文文档,全文带索引,清晰。此书为交流探讨,如果喜欢,请支持正版。人人为我,我为人人。 立即下载

Git 使用文档

适用目标:

  • 新同事快速上手 Git

  • 团队统一分支和提交规范

  • 日常开发、发版、紧急修复时有统一操作方式


1. Git 基础配置

1.1 安装 Git

Windows:

winget install --id Git.Git -e

Mac:

brew install git

Ubuntu:

sudo apt update
sudo apt install git

1.2 首次配置

首次安装后建议先配置用户名、邮箱和默认分支名:

git config --global user.name "你的名字"
git config --global user.email "your_email@example.com"
git config --global init.defaultBranch main

查看配置:

git config --global --list
git config --list

说明:

  • --global 表示当前用户下所有仓库通用

  • git config --list 会同时显示系统、全局、仓库级配置

1.3 生成 SSH Key

推荐使用 SSH 连接远程仓库:

ssh-keygen -t ed25519 -C "your_email@example.com"

如果环境不支持 ed25519,可退回 RSA:

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

查看公钥并复制到 GitHub / GitLab / Gitee:

cat ~/.ssh/id_ed25519.pub

Windows Git Bash 下通常也是同样命令;PowerShell 可直接打开对应公钥文件复制内容。

测试连接:

ssh -T git@github.com


2. 常用仓库操作

2.1 新建仓库

git init

2.2 克隆仓库

git clone <仓库地址>

示例:

git clone git@github.com:org/repo.git

2.3 查看状态

git status

2.4 查看提交历史

git log
git log --oneline --graph --decorate --all

2.5 查看差异

git diff
git diff --cached

说明:

  • git diff 查看工作区与暂存区差异

  • git diff --cached 查看暂存区与最近一次提交差异

2.6 添加与提交

git add <文件>
git add .
git commit -m "feat: 新增用户登录校验"

2.7 撤销常见操作

撤销工作区修改:

git restore <文件>

取消暂存:

git restore --staged <文件>

修改最近一次提交说明:

git commit --amend


3. 分支工作流规范

团队建议采用 Git Flow 思路,核心分支如下。

3.1 永久分支

master / main

  • 用于对外发布稳定版本

  • 不允许直接在该分支开发

  • 仅在发版、热修复合入时更新

develop

  • 团队日常开发主干

  • 所有功能分支从这里拉出

  • 不建议直接在该分支上提交业务开发代码

3.2 临时分支

feature/*

  • 新功能开发分支

  • 从 develop 拉出

  • 自测通过后合并回 develop

release/*

  • 提测、预发、发版准备分支

  • 从 develop 拉出

  • 只允许做发版前修正,不继续叠加新功能

  • 完成后合并回 master/main 和 develop

hotfix/*

  • 线上问题紧急修复分支

  • 从 master/main 拉出

  • 修复后同时合并回 master/main 和 develop

3.3 分支命名建议

feature/login
feature/order-export
release/2026.05.01
hotfix/payment-timeout

3.4 标准开发流程

git checkout develop
git pull origin develop
git checkout -b feature/login

开发完成后:

git add .
git commit -m "feat: 新增用户登录验证逻辑"
git push origin feature/login

然后发起合并请求,由评审后并入 develop。


4. Commit Message 规范

4.1 标准格式

<type>(scope): <description>

scope 可选,推荐在跨模块协作时使用。

4.2 type 类型

类型说明示例
feat新功能feat: 新增报价单导出功能
fixBug 修复fix: 修复价格计算结果错误
docs文档变更docs: 更新接口使用说明
style代码风格调整style: 统一报价模块命名风格
refactor重构refactor: 重构订单状态转换逻辑
perf性能优化perf: 优化报价列表查询索引
test测试相关test: 新增登录服务单元测试
chore构建、配置、杂项chore: 升级 Spring Boot 版本
build构建系统变更build: 调整 Maven 打包参数
ciCI 配置变更ci: 增加发布前校验步骤
revert回滚提交revert: 回滚订单导出接口改动

4.3 描述规则

  • 尽量简短清晰,建议不超过 50 字

  • 直接描述“做了什么”或“修了什么”

  • 不建议只写“修改”“调整”“优化”这种泛化词

  • 标点、括号、冒号、空格统一使用英文符号

示例:

fix: 修复报价截止时间为空时导出报错
feat(设备): 新增设备离线状态消息处理
perf(查询): 优化历史台账关联查询索引


5. 提交粒度规范

5.1 为什么要控制粒度

  • 方便 Code Review

  • 方便定位问题和回滚

  • 降低分支合并冲突

  • 提升团队协作效率

5.2 建议标准

文件数建议:

  • 功能开发:建议不超过 10 个文件,最多不超过 20 个

  • Bug 修复:建议不超过 5 个文件,最多不超过 10 个

  • 重构优化:建议不超过 15 个文件,最多不超过 25 个

代码量建议:

  • 日常开发 / Bug 修复:建议不超过 300 行,最多不超过 500 行

  • 重构 / 迁移:建议不超过 500 行,最多不超过 800 行

5.3 反模式

git add .
git commit -m "feat: 用户模块开发+登录修复+配置调整"

问题:

  • 一个提交里混了多个主题

  • Review 成本高

  • 以后很难精准回滚

5.4 推荐做法

git add config/database.yml
git commit -m "chore: 数据库连接池配置优化"

git add src/login/
git commit -m "feat: 新增用户登录验证逻辑"

git add tests/login.test.js
git commit -m "test: 新增登录模块单元测试"


6. 远程仓库操作

6.1 查看远程仓库

git remote -v

6.2 添加远程仓库

git remote add origin <仓库地址>

6.3 拉取远程更新

git pull origin develop

如果希望历史更线性,可使用:

git pull --rebase origin develop

6.4 推送本地分支

git push origin feature/login

首次推送并建立上游关系:

git push -u origin feature/login

6.5 推送标签

git push origin v1.0.0
git push origin --tags


7. 合并与变基

7.1 merge

适合保留完整分支合并历史:

git checkout develop
git merge feature/login

7.2 rebase

适合整理个人开发分支历史,让提交记录更线性:

git checkout feature/login
git rebase develop

注意:

  • 不要随意 rebase 已经多人共享且他人正在使用的公共分支

  • 如果 rebase 后需要推送已存在远程分支,通常要:

git push --force-with-lease

优先使用 --force-with-lease,不要直接用 --force。


8. 标签管理

标签通常用于版本发布。

创建轻量标签:

git tag v1.0.0

创建附注标签:

git tag -a v1.0.0 -m "release 1.0.0"

查看标签:

git tag

查看标签详情:

git show v1.0.0


9. 高级常用操作

9.1 cherry-pick

把指定提交挑到当前分支:

git cherry-pick <commit-id>

适用场景:

  • 把某个修复从开发分支同步到热修复分支

  • 只选择某一个提交,不整体合并整个分支

9.2 stash

临时保存当前未提交修改:

git stash
git stash list
git stash pop

9.3 reflog

查看本地所有 HEAD 变更记录,可用于找回误删提交:

git reflog

9.4 bisect

二分定位是哪次提交引入问题:

git bisect start
git bisect bad
git bisect good <commit-id>


10. 全局钩子配置

如果希望所有仓库统一校验提交信息,推荐配置 Git 全局钩子。

10.1 创建全局 hooks 目录

Windows:

mkdir C:\Users\YourName\.git_hooks

Mac / Linux:

mkdir -p ~/.git_hooks

10.2 创建 commit-msg 钩子

文件名必须是 commit-msg,不要带后缀。

示例脚本:

#!/bin/sh

commit_msg=$(cat "$1")
pattern="^(feat|fix|docs|style|refactor|perf|test|chore|build|ci|revert)(\(.+\))?: .+"

if ! echo "$commit_msg" | grep -Eq "$pattern"; then
    echo "============================================================================="
    echo "提交拒绝: 格式错误"
    echo "当前信息: $commit_msg"
    echo "正确格式: <type>(scope): <description>"
    echo "示例: feat(报价): 新增导出功能"
    echo "============================================================================="
    exit 1
fi

10.3 配置 Git 使用全局 hooks

Windows 示例:

git config --global core.hooksPath "D:/your-path/.git_hooks"

Mac / Linux 示例:

git config --global core.hooksPath ~/.git_hooks
chmod +x ~/.git_hooks/commit-msg

10.4 验证是否生效

在任意 Git 仓库执行:

git commit -m "随便写一个不合规信息"

如果配置成功,提交会被拦截。

说明:

  • 全局钩子适合统一团队约束

  • 仓库内如果另有独立钩子,需要确认是否与全局规则冲突


11. 第三方依赖管理规范

这一部分更适合前端或依赖较多的项目,但其他技术栈也可参考。

11.1 引入前评估

引入第三方库前建议检查:

  • 活跃度:近 6 个月是否还有更新

  • 维护性:是否持续发版、修复安全问题

  • 社区质量:文档是否完善、社区是否活跃

  • 依赖复杂度:是否引入过多子依赖

  • 兼容性:是否匹配当前技术栈

  • 安全性:是否有已知高危漏洞

  • License:是否符合公司开源协议要求

11.2 版本管理建议

{
  "dependencies": {
    "lodash": "^4.17.21",
    "axios": "~1.6.0",
    "dayjs": "1.11.10"
  }
}

说明:

  • ^1.2.3:允许次版本和补丁版本更新

  • ~1.2.3:只允许补丁版本更新

  • 1.2.3:完全锁定版本

不建议:

  • 使用 latest

  • 使用 *

11.3 锁文件必须提交

例如:

  • package-lock.json

  • yarn.lock

  • pnpm-lock.yaml

原因:

  • 保证团队安装结果一致

  • 避免“我本地能跑,你本地不行”

  • 让 CI/CD 构建可复现

11.4 禁止直接修改第三方安装目录

不要直接修改:

node_modules/

推荐方式:

  • 升级到合适版本

  • 使用补丁方案,例如 patch-package

  • 记录修改原因和影响范围


12. 常见问题处理

12.1 提交后发现用户名或邮箱错误

修改全局配置:

git config --global user.name "正确名字"
git config --global user.email "correct@example.com"

如果只是最近一次提交写错了:

git commit --amend --reset-author

12.2 合并或变基出现冲突

处理步骤:

  1. 用编辑器打开冲突文件

  2. 删除冲突标记并保留正确内容

  3. 重新暂存文件

  4. 继续 merge 或 rebase

rebase 冲突后继续:

git add <文件>
git rebase --continue

放弃本次 rebase:

git rebase --abort

12.3 本地提交落后远程,无法 push

先同步再推送:

git pull --rebase origin develop
git push origin develop

12.4 提交丢了,想找回来

git reflog
git checkout <commit-id>

必要时可基于该提交重建分支:

git checkout -b rescue-branch <commit-id>


13. 团队推荐实践

  • 功能开发从 develop 拉 feature/*

  • 发版从 develop 拉 release/*

  • 线上修复从 master/main 拉 hotfix/*

  • 不直接在 master/main 上开发

  • 提交信息遵循 type(scope): description

  • 一个提交只做一件事

  • 提交前先看 git status 和 git diff --cached

  • 优先用小步提交,避免超大提交

  • 团队统一启用全局 commit-msg 钩子


14. 建议掌握的最小命令集

如果你刚开始用 Git,先熟悉下面这些命令就够了:

git clone <url>
git status
git branch
git checkout -b feature/xxx
git add .
git commit -m "feat: xxx"
git pull --rebase origin develop
git push -u origin feature/xxx
git log --oneline --graph --decorate --all
git stash
git reflog


RS485/CAN总线防护电路设计:TVS选型与ESD防护实战解析 本文深入解析了RS485与CAN总线防护电路设计中的TVS选型与ESD防护实战技巧。针对工业现场常见的静电放电、浪涌等干扰,文章详细阐述了TVS管关键参数的选择、多级防护体系的构建,并特别强调了在隔离电路设计中地回路处理的重要性,帮助工程师设计出更可靠的通信接口。 阅读详情

相关推荐

Hierarchical Flow Partition(Top-down&&Bottom-up)

hierarchy flow是将设计切分成多个block,分别处理单个block,然后完成后,将它们进行拼接以完成最终的chip。一般划分为三个阶段:chip planning;physical budget就是pin assignmenthierarchy flow实现的方法有两种,一种是top-down,另一种是bottom-up,无论是哪种,都是都要通过flatten的方法分别全局范围进行优化实现。

qq_39493558的博客 3076

Git 文档与教程

Git 文档与教程

程永强 1135

新手网工别慌!手把手带你搞定华为OLT开局配置(从登录到业务下发全流程)

本文为新手网络工程师提供华为OLT设备开局配置的详细指南,涵盖从设备登录、基础配置到业务部署的全流程。通过实战案例和常见问题排查,帮助读者快速掌握华为OLT配置技巧,确保业务顺利开通。

weixin_33721344的博客 487

Git 实用学习文档

学习Git两天半!总结一个实用的git学习文档。轻松使用!

yw_WillGo的博客 693

PCL 点云拟合 最小二乘法拟合平面

在点云处理领域,最小二乘法(Least Squares)拟合是一种常用的数学方法,用于估计数据点的最佳拟合曲线或平面。平面拟合广泛应用于点云数据处理中的地面检测、物体表面分析等任务。 本文将介绍如何使用PCL库实现基于最小二乘法的平面拟合算法,通过拟合点云数据中的平面,来提取出数据的平面部分。

纵马踏花向自由 1027

哨兵1号回波数据(L0级)包格式解析与成像参数提取

提取哨兵1号数据包的辅助数据、回波数据、定标数据。matlab代码在文末

3132

Git使用文档

Git Git用法 实在是每次都要去下面找还是去网上找太麻烦了 我还是把具体的用法集合到这里把 这个是最完整的 下次直接看着就好了 1- 下载项目:git clone < 仓库地址> 👇 git clone https://gitee.com/huiiiii/scmgo.git 2- 如果要下载非master的某分支代码:git clone -b < 分支名> < 仓库地址> git clone -b dev https://gitee.com/huiiiii/

weixin_51338848的博客 2159

Windows 11 安装 Miniconda + Mamba,配置国内源

本文详细介绍了在 Windows 11 系统下安装 Miniconda 并配置 Mamba 的完整流程,包括选择精简版 Miniconda 的理由、安装过程中的关键选项设置、配置清华大学镜像源以加速包下载,以及在 base 环境中设置 pip 国内源。同时说明了 Mamba 相较 Conda 的性能优势,并指导用户完成 Mamba 安装与 Shell 集成,最终通过命令验证环境管理功能,帮助用户构建高效、轻量的 Python 开发环境。

寒水馨 · 轻量级技术文档 · hanshuixin.org 3347

Git 笔记

文章目录一、引言二、介绍三、Git安装3.1 下载Git3.2 安装3.3 基本配置3.4 测试四、架构五、仓库5.1 新建仓库5.2 工作区5.3 暂存区5.4 分支六、基本操作6.1 查看仓库状态6.2 暂存文件6.3 提交文件七、远程仓库7.1 远程仓库工作模式7.2 远程仓库选型7.3 基本操作7.3.1 注册git服务器账号7.3.2 新建远程仓库7.3.3 本地关联远程仓库7.3.4 推送文件到远程仓库7.3.5 克隆远程仓库7.3.6 代码共享7.3.7 命令汇总八、分支8.1 分支简介8.2

普通还不自信的程序员 1680

振镜控制卡硬件接口揭秘:XY2-100/SL2-100协议对比

本文对比分析了工业振镜控制领域两种主流数字通信协议XY2-100和SL2-100的硬件接口差异与应用场景。XY2-100作为开放式协议兼容性强,采用LVDS差分信号传输,适用于激光打标等中高精度场景;SL2-100为半封闭协议,采用RS485差分信号,专为高速响应场景设计。文章详细解析了两种协议的引脚定义、通信机制和性能参数,指出XY2-100适配多品牌振镜且调试简单,SL2-100则更适合Nutfield专用设备的高速高精度需求。最后提供了接口调试的实操建议和选型逻辑,强调应根据具体应用场景的精度、速度和

远程部署调试 运行安装 项目调试 二次开发 项目技术新 持续迭代 部分源码免费分享 653

CLCD 中国生命周期基础数据库使用攻略

CLCD 是公共建筑碳排放计算的理想选择,其本地化数据可显著提高计算准确性。

hy行者勇哥的博客 2700

Git详细使用文档

Git是一个分布式的版本控制及协同开发工具

qq_42191775的博客 2242

大模型——AI对话四象限

{ "摘要": "文章揭示了90%的人不会有效与AI沟通的问题,指出简单粗暴的提问只能得到标准答案。作者提出'AI对话四象限'模型:1)双方都懂时提效;2)AI懂但需学会分层提问;3)共同探索未知领域;4)向AI传授独家知识。强调沟通技巧的重要性,认为会提问的人不会被AI替代。最后呼吁读者尝试四象限思维,与AI碰撞火花。" }

312

使用 Git 帮助文档

聊聊如何更好地查阅官方文档。

PeterJXL的博客 941

最新的sdio 4.0 spec 协议标准 带书签 高清完整PDF版

Part-E1-SDIO-Specification-Ver4.00-Final-120220.pdf:最新的sdio 4.0 spec 协议标准 带书签 高清完整PDF版,包括SDIO 接口的外设,SDIO 接口官方协议等。

Probability and Statistics - 4th edition

Probability and Statistics - 4th edition

[转载]Git安装以及使用Git 管理个人文档

1.1 Git 安装Git的最新版本可以在http://git-scm.com/下载,它是基于命令行操作的,网上也有第三方开发的相应GUI可供下载,因为我比较喜欢命令行操作,所以没有对GUi下载和安装,有兴趣的同学可以自己试试。网上也有相应的文章和资料可供参考!安装之前首先确保相应的依赖包已经安装,主要有以下几个:zliblibcurllibcrypto(OpenSSL)rsync(2.6.0 或

Leon 5859

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

Git帮助文档

//Case 952

计算机控制技术及应用

《计算机控制技术及应用》通过总结作者的科研成果和吸收国内外的先进理论、方法和技术,以计算机控制系统的网络化、开放化、智能化和集成化发展趋势为主线索,主要介绍计算机控制系统的基本概念和计算机控制系统的典型形式,计算机控制系统的数学描述与基本分析方法,以及数字PID控制器、最少拍控制系统、达林算法、状态变量设计法等设计方法及其各种改进算法。重点突出计算机控制系统输入输出通道接口的设计方法和典型控制系统的设计案例与实现方法等。

在本地安装git的HTML帮助文档

这个教程将帮助你在本地环境中设置起git的HTML帮助文档。HTML格式的帮助文档看起来更清晰,更详细,并且还有使用示例。 一,运行git help –-web commit查看git默认的保存html文件的路径。 $ git help --web commit #Attempt to open the html help for the commit command #fatal:

huangbowen521的专栏 2655

GIT官方文档

GIT官方文档下载地址:[https://git-scm.com/book/zh/v2]

小蚪蝌的博客 385

Git官方中文文档

git官方文档中文版

qq_45239547的博客 2285

git官方文档阅读指南

进入git文档; 点击 Reference -Getting and Creating Projects - init; 看到一页git init 的使用说明。 如果你英语足够好,说明里的绝大部分内容都可以看懂。不过仍有几点值得我们注意。 1 关于概要 每条命令文档下都有一块该命令概要(synopsis)的区域。 图1 git init 下的 synopsis1.1 每一行都是一种完...

Tabris_k的专栏 833

利用git进行word文档的版本管理

文章目录前言准备配置文件开始写作最后 前言 在进行大文件传输或修改的时候总会遇到存储或传输压力大的问题,而Git在版本迭代方面非常出色。 在撰写毕业论文或其他大型论文时,一篇文章通常需要经过反复修改,往往我们通过复制文件对其重命名来进行版本的标识。这样不仅浪费存储空间,同时,文件管理起来也相当不便。Git作为常用的版本分布式管理软件有效地解决了这一问题,让我们可以对每次改动进行有效的管理;Pandoc是常用的标记语言转换工具,可实现不同标记语言间的转换(HTML、Word、Ebooks、PDF、Te

博客 1万+

使用git、gitbook、openresty实现自动化部署文档中心

序 由于在项目管理中,发现文档的统一管理和传阅非常不方便。 例如使用word,excel等工具,文档零散且分享没有实时性; 使用svn或者git管理,文档可以统一,且可以追溯历史,但是对于分享而言,使用成本过高。 在无意中发现一个叫做gitbook的东西,可以将书籍用git的方式管理,阅读的时候时候则可以通过网站阅读,正好一次性解决了之前的问题。 在调研过程中,发现了许多问题,比如git...

yugi1017的专栏 2540

git 操作使用文档

npm config set registry URL 从git上down代码 $ git clone 地址 查看当前分支状态 $ git status 查看远程主机信息,查看远程仓库地址 $ git remote -v

swallowliyan的专栏 1010

Git系列:运用Git创建空白分支进行项目相关文档管理

对开发小伙伴来说,分支的概念并不陌生,简单介绍一下,就是在版本控制过程中,同时推进多个任务,开发人员可以为每个任务创建单独的分支。使用分支意味着开发人员可以把自己的当前任务从开发主线上分离开,开发自己分支的时候,不会影响主线分支的运行。好处就是:1、同时并行推进多个功能开发,提高开发效率2、各个分支在开发过程中,如果一个分支开发失败,不会对其他分支有任何影响。失败的分支删除重新开始即可。有关分支的操作命令,这里就不多说了,可以自行查找。

小猪家的胖企鹅的博客 2275

git官网的文档

http://git-scm.com/book/zh

lcathm的专栏 646

git 获取 github_Git和GitHub获取开源文档

git 获取 github 我们在OpenStack中广泛使用git作为文档,以便我们可以“像对待代码一样对待文档” —而且我在很多地方都看到了这种趋势,尤其是在Write Docs社区中。 请查看2014年在波特兰举办的Docs活动中的这些演讲: 使用Git和静态站点生成器放弃CMS 大规模文档 在OpenStack中,我们有模仿我们的代码协作的文档工作流。 我们发布供人查...

cumj63710的博客 260
上一篇: 上海亲子游玩资源
下一篇: CC Switch 配置使用Claude Code和Codex
爱钓鱼的程序员小郭
博客等级 码龄10年 100粉丝 40原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

爱钓鱼的程序员小郭

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值