GitHub + Git知识整理

约 6970 字大约 23 分钟

GithubGit

2025-04-10

密码：2ljp

GitHub仓库

历史起源

Git与GIthub的故事

汉化

使用 篡改猴 + Github 汉化插件 链接直达github-chinese

重要

此插件主要针对菜单，按钮功能汉化，无法对README文件内的英文进行汉化，可以借助其他插件，比如沉浸式翻译

快捷键

. 网页版VsCode

/ 快速打开Github搜索框

T 快速定位到文件搜索栏

L 在代码中可以快速定位到行号

. 网页版VsCode

/ 快速打开Github搜索框

T 快速定位到文件搜索栏

L 在代码中可以快速定位到行号

选中行功能：

Copy line 复制这一行
Copy permalink 复制永久链接（可以通过分享链接，与其他人分享代码）
View git blame 查看文件提交历史（每行代码的提交者）

...

在网页版VsCode 中如果想对代码进行调试，Github提供了一个codespace的运行环境，点击运行/调试按钮，点击继续工作，点击Create New Codespace，根据需求从Github申请一个远程的运行环境，点击Run，然后就可以在网页版Vscode中调试修改代码了

重要

Github Codespace 有一定的免费使用额度

在账号Settings，在Billing and plans点击Plans and usage，往下找到codespaces的使用额度，每个账号每个月提供120小时的免费使用额度，超过则需要付费

搜索功能

search

搜索你感兴趣的项目，可以搜索项目，代码，讨论等...

或者使用高级搜索，在Github搜索框中输入 saved:点击Manage saved searches即可创建搜索预设

点击跳转search

Issue分为两种：

open 指的是还没有解决的bug，或者还在讨论的问题
closed 指的是已经解决的bug，或者已经结束的讨论

提示

在使用和学习开源项目中，不妨在搜索框 ↑ 中搜一搜，因为有些问题别人可能也遇到了，并且在Issue中已经有人给出了解决方案

Releases

项目的发行安装包，根据实际需求下载对应安装包，在CMD窗口输入wmic cpu get caption查看自己CPU架构

开源协议

图片http://ruanyifeng.com/blog/Cc-By-3.0/2011.5.2

GPL：其他人修改完代码的项目也必须保持开源（衍生作品也必须开源）

争议：具有传染性，意味着如果一个项目使用了部分GPL代码，则整个项目都必须遵循GPL协议，而且必须保持开源

LGPL：宽松版的GPL协议，新增部分的代码不必要使用原版协议，这样不怕GPL协议传染整个项目

Apache：需要为每个修改后的文件放置版权说明

MIT/BSD：只需要在项目中保留一份协议的副本，就可以几乎随意使用开源代码

BSD：不可使用原作者的名字对项目进行促销推广

Gist

一般用来分享单个代码文件，或者是小的代码片段

分享方式

网页嵌入

<script src="https://gist.github.com/yumengjh/971e97c8855a5bb8e7ba2756f3985dfc.js"></script>

原地址页面：

https://gist.github.com/yumengjh/971e97c8855a5bb8e7ba2756f3985dfc

克隆

...

pull reauest

意思是 拉取请求（合并请求）

将更改从一个分支合并进另外一个分支的提案，通常来说，项目的贡献者在自己的分支上进行代码修改，然后他会创建一个pull request，也就是把自己的分支合并进主干分支的提案

pull request会比较两个分支之间的代码差异

然后仓库的管理员会来审核这个代码的改动，这个过程叫做Code review也就是代码审核

在代码审核过程中，管理员可以提出自己的修改意见，当管理员确认代码改动是OK的以后，他会同意合并，这样特性分支的代码就会合并进主干分支，功能开发也就完成

创建pull request

点击pull request选项，再点击New pull request选项

然后选择合并方向

对修改确认无误后，点击Create pull request，写一个标题，填写描述，完成后点击Create pull request

管理员可以点击Files changed开始审核代码

审核时，管理员可以比较代码的不同，他可以在某一行上点击加号留下评论，最终他会给一个代码审核的意见

最后，管理员认为代码OK，可以合并的时候，就可以点击merge pull request

WiKi

点击头部的wiki标签栏即可进入

用于存放项目的详细文档，指南，API文档，设计文档。适合放置较大，结构化的文档内容

Wiki也是一个独立的Git仓库，可以独立克隆和推送

Insights

用于帮助项目维护者和贡献者分析和理解他们代码库的状态和活动。

Pulse

Pulse是一个快速查看项目近期互动的好方法，可以让你了解项目的动态。

pulse提供了项目的简要活动概要，包括：

已合并的拉取请求（Merged Pull Request）

开启的拉取请求（open Pull request）

关闭的问题（Close issues）

新开启的问题（New Issues）

version: 2
updates:
  - package-ecosystem: "npm" # See documentation for possible values
    directory: "/" # Location of package manifests
    schedule:
      interval: "weekly"

package-ecosystem指的是包管理工作名字

directory指的是项目依赖文件的目录

interval扫描间隔 - weekly指的是每周扫描一次

Dependabot更多功能：点击跳转，进入后搜索 dependabot.yml 即可深度学习Dependabot的配置

Project

Github Project就是项目看板，是一种可视化管理工具，用于组织和跟踪项目的进度任务

Todo 是代办事项
In Progress 是进行中事项
Done 是完成事项

点击卡片左下角即可创建事项

如果开发者看到了一个Issue并且觉得不错，会回答你：期待你PR

贡献:

当图标变成紫色Merged

完成了对开源代码的贡献

仓库的Contributors就会出现贡献者的名字

贡献者可以回到本地将开发分支删除，保留main分支随时关注母项目的改动，有改动点击sync fork同步代码

如果还想进行功能开发，再在Desktop创建分支进行开发就行了

Github大文件

在Github中单个文件的大小是被严格限制的，如果单个文件大于50M，push的时候回触发警告，如果大于100M会直接拒绝

Git LFS (Git Large File System ) ->大文件系统

LFS使用一个单独的文件存储服务器专门存储大文件，我们仓库只存了一个大文件的引用

安装LFS

git lfs install

指定哪些文件需要由LFS管理

git lfs track '文件类型'

*.mp4表示我系统的所有MP4文件都由大文件系统管理

当一个文件大于100M无法推送，得使用LFS就可以推送

重要

存储空间并不是完全免费的，进人右上角个人账号，点击Setting，找到Biling and plans，有一个plans and usage，往下找，有一个Git LFS Data

Github Action

Action脚本

Github 的自动化流水线

可以编写一个action脚本，制定Github完成一系列的自动化操作，最场景的用法就是CI/CD

CI/CD的意思是Continuous lntegration / Continuous Delivery，持续集成持续交付

比如我们希望每提交一次代码的时候，程序能自动完成单元测试，代码编译，程序构建，推送到服务器并且完成部署，这整一套的自动化过程就是CI/CD

Action 市场

由于很多操作在很多项目里面是类似的，完全可以共享

所有允许开发者将每个操作写成独立的脚本文件存放到代码仓库里面

存放官方写好的Action https://github.com/actions

https://github.com/marketplace Github市场，其中也有Action选项卡，可以搜索需要的

每个Action 都是一套自动化的流程，都有相应的代码

引用

引用别人的Action，使用 uses: 作者名称/Action的名称@版本号

uses: sayyid5416/pyinstaller@v1

为什么要定义出job和step两个层级？区别？

不同的job默认是并行运行，这样可以提高效率。并且每个job运行在独立的虚拟环境中，也就是每个job其实都是运行GitHub的不同的服务器里，这样可以避免job之间的相互干扰。

而step是顺序执行，而且同一个job之间各个的step是按照从上到下的顺序在同一个虚拟环境里面顺序执行的

在个人设置可以查看使用额度

Github Desktop

点击跳转GithubDesktop

通过动画学习Git

learnGitBranching项目

部分提交

在Github Desktop代码区域点击行号可以进行指定行的提交

放弃更改

右键文件，选择Discard changes即可放弃更改，指的是放弃这个文件在本地目录(工作区)的修改

还可以右键 1 changed file第一个是放弃所有更改，第二个是保存所有更改

把这个文件(工作区)同步成本地分支(本地仓库)的样子

注

放弃的文件会添加到回收站内，文件可在电脑本地回收站再次找回

保存更改

git stash // git命令

如果工作目录中有未保存的代码，是无法切换分支的，可以选择保存更改代码再切换分支

保存更改后此时本地文件已经没有保存的更改代码了

点击Stashed Changes查看保存的更改，Restore还原，Discard丢弃

重要

局限性：Desktop最多只能存储一次的改动，Git命令行则没有，它可以存储很多次的改动

但是如果强行切换分支，会有两个选择

第一个Leave my changes on feature就是存储更改代码

第二个Bring my changes to main将更改代码带向main分支

场景：如果你有开发了一半的代码，现在出现了一个临时紧急工作，需要切换分支进行处理。

对于还没有提交的改动我们可以进行一下处理:

操作方法	git命令	修改
commit	git add. + git commit -m 'commit message'	工作区文件提交本地分支
stash	git stash	将改动保存起来
discard	git reset --hard	抛弃工作区与暂存区的更改
switch	git switch ‘branch name’	直接切换分支，你的本地改动会带到新分支上。

撤回提交

git reset

点击History，右键之前版本选择Reset to commit即可

撤销提交后，文件改动保存在工作目录中

重要

推送远端后不允许Reset，只限于Desktop，不允许一些高危操作

但是可以使用Git命令行进行操作

右键仓库选择Open in Command Prompt打开命令提示符

查看历史提交记录

git log // 按Q键退出

mix指的是撤销提交，但是保留我的本地文件更改

git reset --mix 'ID'

当通过Git撤销的提交存在远程分支，本地是没有了，因为刚刚通过命令行撤回了，但是还存在于远程，如果在GitHub Desktop点击pull会把那次提交又拿回来了

所以继续使用git命令行操作，把本地分支强行推送远程仓库

git push -f

-f指的是强制推送，不论远端分支是什么状态，就把本地分支强制覆盖到远端（高危操作）

反向提交

git revert

在History页面右键版本选择Revert changes in commit生成了一个新的提交，最后推送即可

Revert 的意思是使用反向操作抵消上一次的更改

反向操作：比如之前是删除一行代码，那就是增加一行代码，反之，新增则是删除

提示

在多人协作开发中，我们应该使用revert操作，而不是使用命令行reset操作，因为推送到远端后，不允许reset后提交，只能拉回代码，但是可以使用命令行强制推送覆盖远端仓库

更改提交

git commit --amend

右键版本选择Amend commit... ，意思是修正更改，点击后即可重新编辑提交信息或者代码

完成后点击Amend last commit，注意：并没有产生新的提交，只是把上一次的提交修正一下

注意：只适用于最新的提交

重要

如果提交已经推送，再点击Amend commit... ，会进行警告，提示我们这次修改完后，必须使用force push强制推送才能把修改推送到远端

Git操作	Git命令	使用场景	注意事项
discard	git restore '文件名' (单个文件) git reset --hard (所有文件)	工作区的修改还未commit	舍弃掉工作区修改的文件
reset	git reset 'commit ID'	还原到某个commit状态，舍弃之后的commit	如果reset已经推送到远端的commit，会强制推送，集成分支禁止强制推送
revert	git revert 'commit ID'	使用一个新的提交抵消掉某一次commit的修改
amend	git commit --amend	只能修改最新一次commit	如果amend 已经推送到远端的commit，会强制推送，集成分支禁止强制推送

分支合并

之前使用的是Github网站进行pull request进行合并

也可以使用GIthub Desktop进行merge分支合并

git merge

首先切换到接受合并的分支

点击Choose a branch to merge into ***，选择一个分支合并进当前分支

Create a merge commit

git merge main

Create a merge commit：创建一个新的commit，合并到一起

Squash and merge

git merge --squash main

Squash and merge：把commit3,4,5压缩成一个提交合并进feature分支

Rebase

git rebase main

Rebase（变基 - 更改地基）：把main分支合并进了feature分支，把feature分支变基到了main分支

变基：我自己的根基不存在了，把自己的分支变更到了main分支上，并且生成一个新的提交

重要

在Desktop使用变基，提示必须强制推送到GIthub网站Git push -f

操作	rebase	merge	squash merge
特点	只有线性提交记录	会出现所有提交记录，包括merge	只出现一条merge记录
优点	减少一次merge记录	保证分支可溯源	历史记录更加清爽干净
缺点	必须使用强送	多一次merge记录	历史记录被合并到一起了
应用场景	在私有分支上可以使用rebase	多人协作分支必须merge，向主干分支合并必须merge	多人协作分支，需要保持记录清爽

Github网页中pull request也有一样选项

优选提交

cherry pick指的是优选提交或者拣选调教

比如说只想把commit3，commit3合并到main分支，保留commit5分支在feature分支

使用命令行操作

切换到接受合并的分支

git switch main

选择c3，c4两个commit

git cherry-pick c3 c4

使用Desktop操作

按住shift键同时选择多个commit，右键选择Cherry-pick...，指的是拣选选中的提交

选择要合并的分支，最后点击Cherry-pick commit to main即可

[!important] 小记
在Desktop中Cherry-pick时，要将分支切换到输出commit的分支，然后再选择若干个commit，命令行则反之

合并冲突

如果两个分支同时修改了同一个文件的同一行代码，合并的时候就会出现conflict（冲突）只能手动修改文件来解决冲突

Abort merge：取消这次的merge，两个分支各自还原回去

Continue merge：需要先手动解决冲突，即编辑文件，修改成理想状

进入VSCode手动修改代码后回到Desktop即可点击Continue merge

拉取冲突

场景：你的同事，她已经写完代码并且推送到远程仓库，但是你本地不知道，你修改了同一个文件的同一行，此时你还没有提交

点击pull origin，提示冲突，如果拉取更新会将本地代码覆盖，

点击Stash changes and continue，存储更改并继续，此时进入文件修改冲突，

回到Desktop✔表示已经解决了，即可commit提交了再push了

文件冲突

场景：两个分支同时改动了同一个文件的名字

选中所有文件右键Discard 3 selected changes全部撤销更改

打开目录调整为理想状态回到Desktop

点击View conflicts，最后再提交上去即可

git命令行

安装Git

检查是否安装

git --version

克隆

git clone url

状态

查看目前的状态，目前分支，是否与远端分支同步，以及文件修改，暂存区...

git status

添加暂存区

使用Git add . 会把所有修改的文件添加到暂存区

git add 'filename'

取出暂存区

git restore --staged 'filename'

提交

git commit -m 'msg'

暂存+提交

git commit -am 'mag'

重要

-a的意思是把所有的文件添加到暂存区，

注意：只添加修改的文件，新增的文件还是得 git add .

推送

git push

当第一次推送的时候，会有登录提示，选择GIthub或者Token

Token：进入GIthub点击Setting，下拉找到Developer settings，有一个Personal access tokens

打开，点击Token(classic)，点击Generate new Token

选择一个过期时间，勾选全部功能，最后选择Generate token

生成了一个Github token，复制，填写到登录Token处即可完成绑定

拉取

git pull

建议

建议使用git pull --rebase，这个命令可以在拉取更新的时候产生线性提交记录

场景：

当写完代码push到远端，被决绝了，原因是团队中其他同事也使用了相同的分支

两人都是从A提交开始写代码，两人同时在写代码，但是同事先把代码提交到远端

当你推送的时候，就会拒绝

所以，在实践中，推荐每个人都使用一个独立的分支开发代码，避免此类问题

但是，当两个人需要共同解决同一个分支上的问题时，此时，执行git pull 命令即可

先把远端的最新提交拉取到本地

git pull = git fetch + git merge

因为你的提交和你同事的提交有共同的祖先，Git会merge两个分支的提交，并且创建一个额外的merge提交

经常这么干会累计很多无用信息，把搜索commit变得麻烦，

我们的目的仅仅是：把自己的提交挂在你同事提交之后，即可保持历史数据线性的干净

可以使用git pull --rebase命令，完成操作

此命令会暂时把你的提交放到一边，然后拉取远端仓库的提交，再把你的提交挂在后面，即可保持提交线性的干净

可以修改Git 设置，让Git pull的时候默认使用rebase的方式

git config pull.rebase true

同时Desktop也会变化

删除

当删除了一个文件，使用

git rm 'filename'

告诉git 这个文件以后不需要管理了,文件夹内也会删除

重命名

git mv 'Oldfilename' 'Newfilename'

移动

git mv 'filename' 'file'	// 文件名称+文件夹路径

提交历史

git log

重置状态

git reset --mixed 'ID'

文件修改保留在工作区，之后需要使用强制推送git push -f

丢弃更改

把指定的文件放弃更改

git restore 'filename'

提交详细信息

git show 'ID'

反向操作

会生成一个反向操作抵消那一次的的更改

git revert 'ID'

填写完提交信息，点击Esc，输入一个冒号，一个wq!，回车

修改提交

使用git amend修改提交

当代码提交后，突然后悔了，或者改错了，直接在代码中修正，

现在需要把修改加到上一次提交中，首先git add .

修改上一次的提交记录，git commit --amend

还可以修改上一次的提交信息，点击Esc，冒号，wq!，回车

完成了使用amend操作把上一次添加修改了

注

amend只能对最后一次提交失效

如果还没有推送，使用git push就行，如果推送了，使用git push -f，强制推送

后悔药

操作	命令	场景	注意事项
discard	git restore 'filename' 单个文件 git reset --hard 所有文件	工作区的修改还没有提交	舍弃掉工作区修改的文件
reset	git reset 'ID'	还原到某个提交的状态，舍弃之后的提交	如果reset已经推送的提交，会造成强制推送，集成分支禁止强制推送
revert	git revert 'ID'	使用一个新的提交抵消到某一次的提交	在集成分支推荐使用此命令
amend	git commit --amend	只能修改最新一次的提交	如果amend已经push的提交，会造成强制推送...