很多人听说过 GitHub,但从来没打开过。这篇就是写给这部分人的:10 分钟,从注册到 Star 第一个仓库。

先注册:3 分钟

打开 github.com,点 Sign up,填邮箱、设密码、起个用户名。用户名想好再定,以后改起来麻烦。邮箱验证一下,注册就完成了,不用绑卡,不用实名。

注册完先做一件事:头像和简介随便填点什么。空头像的账号去给人提问题,回复率会低一些,这是实话。

Star 是什么:不是点赞,是收藏夹

看到仓库右上角的 Star 按钮,点了就是收藏。这个仓库进了你的收藏列表,以后在个人主页的 Stars 里能找到。

Star 有两个作用:对你,是书签;对作者,是认可。一个仓库 Star 多,通常意味着用的人多、质量不差,但 Star 不是唯一标准,后面我会专门写一篇怎么判断仓库质量。

别害羞,看到好东西就 Star,这是 GitHub 的基本礼仪。

Fork 是什么:复制一份自己改

Star 是收藏,Fork 是复制。点 Fork,这个仓库就完整复制到你的账号下,你可以随便改,不影响原仓库。

什么时候用 Fork?两种情况:一是你想改点东西自己用,比如改个配置、修个 bug;二是你想给原作者贡献代码,先 Fork 到自己名下,改完再发起合并请求。

新手期 Fork 不用多,先理解概念就行。

第一个 Star 给谁

我推荐从 awesome 系列开始。比如 sindresorhus/awesome,这是一个"列表的列表",收集了各种主题的 awesome 清单:编程语言、工具、学习资源,应有尽有。

从 awesome 入手有两个好处:一是它本身就是导航站,顺着它能找到大量优质仓库;二是每个 awesome 清单都有简介和分类,适合新手建立认知。

操作:打开这个仓库,点 Star,然后顺着它的列表,看到感兴趣的主题点进去,再 Star 几个。就这么简单。

Watch 又是什么:第三个按钮

Star 旁边还有个 Watch,点了之后,这个仓库有新动态(比如发新版、有人提 issue)你会收到通知。

什么时候用 Watch?当你依赖某个工具的时候。比如你用某个开源笔记软件,Watch 它的仓库,新版本发布你第一时间知道。Star 是收藏,Fork 是复制,Watch 是订阅更新。三个按钮分工不一样。

新手常见误区

误区一:Star 了等于会用了。Star 只是收藏,收藏夹吃灰是每个人的常态。我的建议:Star 完顺手点开 README 看一遍,至少知道这个项目是干什么的、怎么安装。

误区二:只看 Star 数。Star 高的项目不一定适合你。先看 README 的"这是什么",再看最近更新时间,最后看 issue 区有没有人在讨论。这三步比 Star 数靠谱。

误区三:不敢提问。每个仓库都有 Issues 区,遇到问题先搜索,有人问过就直接看答案;没人问过就自己提一个,把报错信息贴全。提问是参与开源的第一步,没人会笑话新手。

给仓库提 issue 的基本格式

新手第一次提 issue 容易写成"用不了,求助"。这种问题没人能回。基本格式记一下:

  1. 环境:操作系统、软件版本,写清楚。
  2. 复现步骤:你做了什么,第一步、第二步。
  3. 期望 vs 实际:你以为会发生什么,实际发生了什么。
  4. 报错信息:原样贴上来,别只贴"我觉得关键的那几行"。

按这个格式提问,回复率会高很多。很多时候,写清楚问题的过程,自己就把答案找到了。

接下来:从看客到参与者

注册加 Star,只是拿到了门票。GitHub 真正的用法是:

  1. 遇到问题先去对应仓库的 Issues 里搜,大概率有人问过。
  2. 文档看不懂就看 README,README 是每个仓库的说明书。
  3. 有能力了再尝试 Fork 改代码、提合并请求。

先收藏,再使用,最后参与。这个顺序别反。

下一篇我会写 GitHub 的高级搜索语法,解决"想找某个东西但搜不出来"的问题。