关于 GitHub 的奇技淫巧

news2024/9/29 11:29:11

介绍下多年来使用 GitHub 所了解到的技巧

‍

学会看文档

如何学习使用 GitHub 呢？最好的方式就是：阅读官网文档。

官方文档通常比任何教程都 全面、权威、准确。网上教程和文章满天飞，但都是建立在官方文档的基础上，一旦官方文档修改了，很难做到实时同步，就可能会让学习者感到困惑。

对于有经验的程序员来说，通常都会选择阅读官方文档来学习技术。

此外，GitHub 文档还有中文版，翻译地挺到位的，非常推荐阅读。

官网文档地址：https://docs.github.com/zh

英文版的地址：https://docs.github.com/en

对于已经掌握 GitHub 基本用法的朋友，也可以利用该文档查漏补缺，了解更多提升 GitHub 使用效率和工作效率的强大功能。

‍

如何找到优质项目

除了多敲代码写项目，阅读优秀项目的源码，也可以提高我们的编程能力。那么，就有几个问题需要解决：

去哪找
什么是好
怎么找

‍

去哪找

目前业内有很多仓库托管服务平台，例如 GitHub、Gitee、SourceForge、OSChina…

但最好的一定是 GitHub。在这里，你可以找到各种各样的开源项目，大到世界知名框架、小到个人练习片段，还能和他人一起协作完成项目。

Gitee 其实就是国内版的 GitHub，但项目数远不及 GitHub。

而 OSChina （开源中国）和 Gitee 有非常紧密的合作，将一些开源项目进行了整理分类。

‍

什么是好项目

首先，没有最好的项目，只有最合适的。但我们可以通过一些指标和信息来进行基本的评判。

打开一个项目的页面，一个好项目通常有如下特点：

更多的 star（收藏），对项目实用性的肯定
更多的 Fork（派生搬运），表示想要学习项目或做贡献
更多的 watch，表示对项目的关注度高
积极的 issues（问题），表示更多人使用项目并希望改进
积极的 Pull requests（代码合并请求），表示更多人愿意合作贡献代码
频繁更新最近提交时间，表示项目仍在维护
可直接访问的官网，更正式
类别标签明确，帮助开发者对项目进行定位

‍

以 ant-design 为例：

‍

然后我们接着往下看，一个好项目的 README.md（项目描述）通常会很完善，例如有图标、徽章、多种语言的文档、介绍、用法…

‍

怎么找

‍

GitHub 搜索

最简单粗暴的方法：想学什么就搜什么，然后根据一些简单的排序规则（例如根据 star ）来筛选。

例如学后端，就搜索 backend：

‍

但这样太简单了，我们可以加上过滤条件，只需在搜索时加上一些参数即可：

in:name <关键字>：指定查询仓库名称中包含“关键字”的仓库
in:description <关键字> ：指定查询仓库描述中包含“关键字”的仓库
in:readme <关键字>：指定查询 readme 中包含“关键字”的仓库
stars(fork): >(=) <数字> <关键字>：查询 star 或 fork 数大于或等于指定数字的仓库，并且指定关键字
stars(fork): 10..20 <关键词>：查询 star 或 fork 数在 10 到 20 之间的仓库，并且指定关键字
size:>=5000 <关键词>：查询 star 大于等于 5000K 的仓库，并且指定关键字
pushed(created):>2019-11-15 <关键字>：更新（或创建）日期在 2019 年 11 月 16 日之后的仓库，并且带关键字
license:apache-2.0 <关键字>：查询 LICENSE 为 apache-2.0 的仓库，并指定关键字
language:java <关键词>：查询仓库语言为 Java 的仓库，并且指定关键字
user:<用户名>：查询某个用户的项目
org:<组织名>：查询某个组织的项目

‍

示例：

# 示例 1：查询仓库名包含 javascript，并且 stars 数大于 1000 的项目
in:name javascript stars:>1000

# 示例 2：查询描述中包含"小程序"、 fork 大于 100、最近更新时间在 2019-11-15、并且开发语言为 vue 的项目
in:description 小程序 fork:>100 pushed:>2019-11-15 language:vue

‍

这么多过滤条件完全不用记，我们可以直接可以用**高级搜索页，自动生成搜索表达式：**https://github.com/search/advanced