编码人生

Github入门

Mr.WyjOctober 29, 2022
  • Guide
  • Markdown
About 7 min

Github可以做什么？

GitHub 是一个用于版本控制和协作的代码托管平台，它可以使我们可以在任何地方和任何人一起协同开发同一个项目，并将项目源码存储在 GitHub 上。学会使用 Github，我们可以进行以下操作：

  • 存储你的代码到 Github 仓库中
  • 随时随地在本地修改你的代码，并提交到 GitHub 上
  • 在 Github 上寻找免费开源的编程项目进行学习
  • 和你的小伙伴共同完成一项任务，在 Github 上你们将会拥有各自不同的开发分支，最终将写好的代码合并到主分支上

为了完成以上任务，首先我们需要注册一个Github账户Join GitHub · GitHubopen in new window，接下来便可以使用 Github 执行一系列操作

Github上创建代码仓库

Github 仓库（Repository）是用来存储代码的地方（类似你的代码存储在本地电脑的某个文件夹下），创建一个仓库需要执行以下操作即可：

  1. 在任何页面的右上角，点击 ＋ 号创建 （New repository）一个新的仓库

    image-20220204115437711

  2. 输入仓库的名字 Reposity name（必填项）输入一段简短的描述 Description

  3. 设置仓库为所有 private（只可以自己访问） 或者公共 public

  4. 添加一个 README.mdopen in new window 文件，用来对要存储的项目工程进行一个简单的描述

  5. 创建仓库 Create Reposity

    image-20220208214926860

创建好一个仓库之后，便可以使用该仓库存储代码

在代码库下创建分支

Github仓库使用概念“分支” branch 来管理我们的代码，默认创建的仓库存在一个命名为 main 的主分支，该分支通常用来存储最终的版本代码。我们可以创建其它的分支（相当于拥有主分支代码的一份拷贝），在该分支上对代码进行编辑修改，且不同分支上修改代码互不影响。如果此时有多个人协作完成一个项目，那么每个人可以创建自己独立的分支修改代码。最终将完成的代码合并到主分支上。下图显示了在分支上进行的一系列操作：

image-20220204131422734

  • 箭头方向代表主分支 main
  • 创建了一个名为 feature 的分支
  • 在 feature 的分支上对代码进行编辑修改，最终将 feature 的分支合并到主分支 main

在 Github 仓库 hello-world 下创建并使用分支的具体操作流程如下：

  1. 点击 hello-world 仓库 Code 选项下名为的 main 的下拉菜单项

  2. 输入想要创建的分支名 dev

  3. 点击 Create branch:dev from 'main'，创建并进入了新的分支 dev

    image-20220208214702854

在分支上编写代码并提交请求

当我们创建好一个新的分支之后，便可以在该分支下编辑修改相应内容并保存更改。Github 上，保存更改操作称为”提交请求“Commit changes ，每次提交请求时要求我们输入一个提交信息，这个提交信息解释了你此时提交的内容有哪些修改。之所以写提交信息，目的是为了让和我们一起协作完成项目的其它参与者方便的了解到当前代码有哪些更改。

比如我们要在 dev 分支修改 README.md 文件，步骤如下：

  1. 在 dev 分支下点击README.md文件右上角的编辑选项（铅笔图标）

    image-20220204195904037

  2. 在编辑界面编辑修改之前的 README.md 文件

    image-20220204200739593

  3. 在 Commit changes 编写提交信息并提交更改 image-20220204200927462

Tips

以上只是在 dev 分支上对 README.mdopen in new window 文件进行了更改，提交请求只会改变当前分支的内容，main 分支以及其它分支（如果存在）上的 README.meopen in new window 文件不会发生任何变化

在分支上提交请求后发起拉起请求

一旦我们在某一个分支上提交请求之后，我们便可以发起拉起请求。

dev 分支发起拉起请求之后，相当于告诉在其它分支的协作者：**我对 hello-world 项目中的 README.mdopen in new window 文件进行了修改，你可以对我修改的内容进行审查，如果没有任何问题，你可以将我修改的内容合并到你的分支上！**dev 分支发起拉起请求，请求 main 分支审阅内容并合并 dev 分支所作修改操作流程如下：

  1. 单击 hello-world 存储库的 Pull requests 选项卡

  2. 单击 New pull request 新建拉起请求

  3. 在比较请求 Compare changes 下的下拉框中， compare: 下拉框选中 dev 分支（请求发起者），base:下拉框选中 main 分支

  4. 比较页面上查看更改内容，确保是我们最终要提交的内容

  5. 点击 Create pull request（创建拉起请求），并给你的拉取请求写一个简短的标题和一段描述信息

  6. 再次点击当前页面下的 Create pull request

Tips

流程步骤4中比较页面上的查看更改内容，不同颜色代表不同更改，增加的内容以绿色显示，行的最前端以 + 号开头，删除的内容以红色显示，行的最前端以 - 号开头

合并拉起请求的内容

dev 分支对 main 分支发起了拉起请求之后，main 分支可以对 dev 分支修改的内容进行查看，如果没有任何问题，便可以合并 dev 分支对 hello-world 内容所作的修改

main 分支合并 dev 分支内容流程如下：

  1. 点击 hello-world 存储库 Pull request 选项，会看到有一条拉起请求，点击该拉起请求

  2. 点击 Files changed 选项，查看 dev 分支内容与 main 分支内容的不同

  3. 如果没有问题，在与 Files changed 同级选项 Conversation 下点击 Merge pull request 合并请求

    image-20220205120010687

  4. 合并请求之后，此时主分支 main 的内容和 dev 分支一样了，如果项目已经完成，此时可以选择删除 dev 分支

至此，我们已经学会了在 Github 上创建一个项目存储库，并在存储库上进行一系列操作。然而，我们往往需要做的是：

  • 在我们的本地电脑上编辑修改代码，之后将代码上传到 Github 仓库中
  • 从 Github 上下载代码到本地电脑

以上操作需要我们本地电脑下载版本控制系统 Git 来实现，具体实现见下节内容。

Github 上寻找优秀的开源项目

Github 上发掘好的开源项目很简单，往往好的开源项目 Star 标星数较多（相当于点赞），当然，也存在许多尚未被发掘的开源项目。方式如下：

  1. 在 Github 搜索框中输入 stars:>5000，表示检索标星大于 5000 的项目

    image-20220207165439784

    检索界面展示：

    image-20220207175419969

  2. 当然，你也可以类似在百度检索信息一样，在 Github 搜索框中输入具体想要寻找的项目的名称。当你发现一个优秀的开源项目之后，进入该项目所在仓库，比如你进入上图 Snailclimb/JavaGuide 仓库，便可以学习其他人的项目

    image-20220207180327702

    fork 他人的项目会在你自己的 Github 中创建一个同名的仓库，并克隆一份项目的副本：

    image-20220207181002663

    如果你发现克隆的项目有错误内容，你可以在自己的仓库下对该项目进行修改，修改之后可以发起一个 Pull requests

0  Words
Comments
  • Latest
  • Oldest
  • Hottest
Powered by Waline v2.13.0