服务端相关 / GitHub 仓库

GitHub 仓库

这一节,我将带领大家一步一步创建一个代码仓库,然后了解一下仓库里面有哪些常用的特性和功能。

1. 创建仓库

大家可以根据下面的这张图片来学习创建 GitHub 仓库的几个主要步骤。
图片描述

  1. 点击 “New repository” 进入项目创建页面;
  2. 填写项目名称(必须),一般起一个简单的英文名;
  3. 填写项目描述(非必须), 可以简单描述一下项目功能之类的;
  4. 选择你要创建的是私人仓库还是公共仓库,如果你选择创建公共仓库,那么你的项目每个人都可以看到,如果是私人仓库,只有你和你所指定的人才可以看到;
  5. 选择是否需要生成 readme 文件,待会我会介绍这个 readme 文件是干嘛的;
  6. 选择添加 gitignore 和 license 文件,gitignore 文件的作用是配置一些你在本地开发时无需上传到远程代码仓库的文件,license 就是证书文件,一般可以不添加,或者添加 MIT license;
  7. 点击 “Create repository” 确认创建。

2. 仓库结构

接下来让我们看一下代码仓库的界面,看看界面上有哪些我们需要关注的信息和功能。
图片描述
重点看下我标注的这些模块,我会一一讲解这些模块的功能:

  1. Used by: 展示了这个项目被 github 上其他项目使用的次数,例如图中的 React 是个知名的前端库,所以使用者众多;
  2. Watch: 点击 Watch 后,相当于你就关注了这个项目,那么以后要是这个项目有更新,你就会收到提醒;
  3. Star: 类似朋友圈点赞功能,你觉得这个项目不错,就可以给它点赞;
  4. Fork: 拷贝一份项目到你自己的仓库,不过如果原仓库后面有更新,你自己的仓库不会自动更新代码,需要通过其他方式同步过来才行。
  5. Issues: 当你在使用公共库发现了 bug 或者有疑惑的时候,就可以在 Issues 模块提出问题,等待仓库作者或者其他使用了这个仓库的开发者来解答;
  6. Pull requests: Pull request 列表,Pull request 简称 “PR”,意思是向这个仓库提交代码合并请求;
  7. 描述: 之前创建仓库时填写的描述会展示在这里;
  8. commits: 代码提交记录;
  9. branches: 代码分支;
  10. releases: 代码发布的历史版本可以在这里找到;
  11. contributors: 仓库的贡献者,只要你向这份仓库贡献过代码,就会出现在这个列表里面;
  12. 颜色条: 仓库中所用到的各种代码语言占比;
  13. Branch: 点击这里可以切换不同的分支,图中可以看到现在是 master 分支;
  14. New pull request: 创建一个代码合并请求;
  15. Clone or download: 使用 git clone 项目仓库,或者直接下载项目压缩包。
    接下来,我会介绍上面其中几个功能的妙用和小技巧。

2.1 Used by 妙用

点击 Used by,我们可以看到如下界面:
图片描述
可以看到使用这个开源库的项目列表,点击右边的数字还可以看到更加详细的列表。有时候我们想要使用某个开源库,但是它的项目文档写的不怎么友好,看完文档还是会有疑惑,不知道怎么正确使用。这时候,我们就可以点击列表上使用过这个开源库的项目,多打开几个,对比一下别人怎么使用的,然后再总结应用到自己的项目中。

2.2 Watch 和 Star

这里之所有把这两个放在一起讲,是因为他们的功能有类似的地方,都是相当于关注了这个项目。但是又有很大不同,当你 Watch 这个项目后,表示你以后会关注这个项目的所有动态,以后这个项目有任何变动,都会提示你,如果你设置了个人邮箱,还会给你发邮件,而 Star 就不会。

其实最早的时候 Github 是只有 Watch 的,然后发现很多人 Watch 项目只是拿来当收藏夹用的,于是就有了 Star,所以现在你清楚怎么使用这两个功能了吧。

  • 如果你想关注这个项目,后续想要第一时间获取到项目的最新动态,就 Watch 它吧;
  • 如果你只是想收藏它,方便以后快速查找,就 Star 它。

2.3 Releases

点击进入 Releases 模块界面:
图片描述
在这个界面,我们可以看到每个版本更新了哪些内容,修复了哪些 Bug,以了解开源库的版本信息。

3. 仓库介绍

一个好的开源项目仓库,肯定需要一个好的项目介绍文档,来说明这个项目到底是干啥的,怎么使用等。这个时候 Readme 文档就发挥重要作用了。Readme 文档里面的内容会出现在仓库首页,项目目录的下方,一目了然,我们在看开源库的时候一般第一时间就是通过看他的 Readme 文档来了解这个项目。
图片描述

4. 总结

学习了这一节后,同学们可以在 Github 上创建一个属于自己的仓库哦,取一个简单而有意义的项目名称,写上一段简短的描述,先写一个初始化的 Readme 文档,后续再补充完善。