github常见用法示例

本文总结了一些 github 最常见的使用场景,包括:

  • 使用他人的项目
  • 创建自己的项目
  • 参与他人的项目
  • 维护分支

使用他人项目使用——clone

项目代码是在 github 网站上的,我们要将网站上的代码下载到本地,可以点击网站仓库中的下载按钮,也可以使用 git clone 操作。

点击下载按钮会直接下载一个项目仓库的 ZIP 包,解压就可以使用,这种是不会在本地创建一个仓库的,也就是说您获得的是纯粹的源码。

而使用 git clone 操作会获得一个带有 .git 文件夹的项目,这样您就会得到一个带版本控制功能的仓库!

更新项目——pull

使用 git clone 操作后,您就可以使用 git pull 命令更新项目了。

git pull 命令会从远程仓库拉取最新的代码,并合并到当前分支中,这样您就可以获得项目作者提供的各种更新。

创建自己的项目

可以在 github 网站创建自己的项目仓库,之后使用 git clone 命令克隆到本地,就可以使用 git 管理自己的项目了。

提交修改——add、commit

git clone 命令会在本地建立一个仓库,那么对项目的修改也应该首先提交到本地,之后再推送到 github。

使用 git add 命令将修改的文件添加到暂存区,使用 git commit 命令将暂存区的修改提交到本地仓库。

推送修改——push

使用 git push 命令可以将本地仓库的修改推送到 github。

参与他人的项目——fork

这里分为两种情况,如果您只是想要稍微改动他人的项目自己使用,那么您只需要下载、修改、使用就可以了。(需要注意项目的 License 是否允许您这么做)

但是如果您想要参与项目,贡献代码,那么一般的流程是这样:

和作者沟通您的想法——issue

issue 在 github 的项目页面里,就像一个论坛,您可以直接发 issue 和作者沟通想法。也许您的想法并不符合项目的方向,也许您的想法作者已经考虑到了,总之在参与项目之前先沟通总是个好习惯。

创建属于您的仓库——fork

使用 github 页面上的 fork 按钮可以创建一个属于您的项目仓库,这个仓库会标记 forked from xxxx,您可以 clone 这个仓库,进行修改,随后 commit 提交,随您喜欢。

如果您只是想维护一个自己的分支,那么这样就足够了,但是如果您想将您的修改推送到项目主仓库,那么还需要一个操作:

贡献修改——pull request

当您将本地的修改使用 git commit git push 推送到您的 fork 仓库后,github 页面上会看到一个 open Pull Request 的按钮,可以将您的修改请求推送给主仓库。如果主仓库的持有者同意,那么您的修改就会被合并到主仓库中,您也就完成了一次代码贡献。

维护分支

当然,假设您需要——在本地拥有两个分支(branch),一个用来同步线上的主仓库,另一个用来维护自己的修改,同时两个仓库都接受主仓库的更新,那么您可以:

创建分支——branch

使用 git branch 命令可以创建一个分支,例如 git branch zh 会创建一个名为 zh 的分支。

切换分支——checkout

使用 git checkout 命令可以切换到某个分支,例如 git checkout zh 会切换到 zh 分支。

使用 git branch 会显示本地仓库的分支列表,以及当前正在使用的分支。

追踪主仓库的更新

假设主仓库为:

  • xxx/master

而我们的仓库是:

  • vc/master (从主仓库 fork)
  • vc/zh (这是我们自己创建的分支)

主仓库更新后,我们可以在 github 页面(vc/master)点击 Update branch 按钮,这样会让我们的 master 分支获得最新的代码。

随后我们需要在本地使用 git pull 命令拉取主仓库的更新,这样我们本地的 vc/master 分支也会获得最新的代码。

合并分支——merge

使用 git checkout zh 命令切换到我们自己的修改分支,使用 git merge master 命令将主仓库的更新合并到当前分支中。

这样我们自行修改的分支也会获得最新的代码。


github常见用法示例
https://vitsumoc.github.io/github常见用法示例.html
作者
vc
发布于
2024年11月28日
许可协议