GitHub 开源项目贡献指南：从入门到“PR”

Git GitHub

Git

文章字数: 1.7k

阅读时长: 5 分

曾经，你是否也对 GitHub 上那些酷炫的开源项目心生向往，想要为其添砖加瓦，却又不知从何下手？看着满屏的代码和复杂的流程，是不是有点“望而生畏”？

别担心，这篇文章就是为你准备的“武林秘籍”。我将用最接地气的方式，带你一步步从一个“门外汉”变成开源社区的“贡献者”。准备好了吗？让我们一起开启这段奇妙的旅程吧！

万事开头难，对于新手来说，找到一个合适的项目至关重要。一个好的起点能让你信心倍增。

“Good First Issue”—— 新手村的“任务”

很多开源项目非常欢迎新人的加入，他们会贴心地为新手准备一些“入门级”的任务，并打上“good first issue”的标签。这些任务通常是一些文档的修补、简单的 bug 修复等，非常适合用来练手。

你可以在 GitHub 的搜索框里直接搜索 good first issue，然后筛选你感兴趣的编程语言，就可以找到大量的“新手村任务”。

从你熟悉的工具开始

另一个好方法是从你日常使用的工具或库入手。因为你对它足够熟悉，所以更容易理解它的代码逻辑和需求。比如，你经常使用某个前端框架，那就可以去它的 GitHub 仓库看看有没有什么可以贡献的。

找到了心仪的项目，接下来就要准备好我们的“作案工具”了。别怕，这里的工具都很简单。

Fork 项目：Fork 就像是把别人的项目复制一份到你自己的 GitHub 仓库里。这样你就可以在自己的地盘上随便“折腾”，而不用担心影响到原项目。在项目主页的右上角，你会看到一个 “Fork” 按钮，点它！
Clone 到本地：现在，你的 GitHub 账号下已经有了这个项目的副本。接下来，你需要把它下载到你的电脑上。
```
git clone https://github.com/your-username/project-name.git
```
记得把 your-username 和 project-name 替换成你自己的用户名和项目名。
创建分支：为了保持你的本地主分支（通常是 main 或 master）和原项目同步，最好创建一个新的分支来存放你的修改。
```
git checkout -b your-new-branch-name
```
给你的分支起一个有意义的名字，比如 fix-a-typo 或者 add-new-feature。

现在，你可以在你新创建的分支上大展拳脚了！根据你领取的“任务”，开始修改代码吧。

【案例】修复一个文档里的错别字

假设我们找到了一个项目，它的 README.md 文件里有一个错别字。我们的任务就是把它修正过来。

代码修改好了，接下来就是把它提交上去。

查看修改状态：
```
git status
```
这个命令会告诉你哪些文件被修改了。
添加修改的文件到暂存区：
```
git add .
```
这个命令会把所有修改过的文件都添加到暂存区。你也可以只添加某个特定的文件，比如 git add README.md。
提交修改：
```
git commit -m "Fix: correct a typo in README.md"
```
-m 后面的内容是你的提交信息。一个好的提交信息应该清晰明了，让人一眼就能看懂你做了什么修改。

编写规范的 Commit Message

一个好的 commit message 能让项目维护者更好地理解你的修改。通常建议遵循以下格式：
- 标题行: 简明扼要地描述修改内容，最好不超过 50 个字符。
- 主体内容 (可选): 更详细地解释为什么要做这个修改，以及它是如何工作的。
推送到你的远程仓库：
```
git push origin your-new-branch-name
```
这个命令会把你本地的修改推送到你之前 Fork 的 GitHub 仓库里。

万事俱备，只欠东风！现在，是时候向原项目发起“总攻”，也就是创建一个 Pull Request (PR) 了。

回到你在 GitHub 上的项目页面，你会看到一个黄色的提示条，告诉你最近有分支被推送上来，并有一个“Compare & pull request”的绿色按钮，点它！
填写 PR 信息：
- 标题：一个清晰的标题能让项目维护者快速了解你的 PR 内容。
- 描述：详细说明你做了哪些修改，为什么要做这些修改，以及这些修改会带来什么影响。如果你的修改是为了解决某个特定的 issue，记得在描述里链接那个 issue，比如 Closes #123。
  
  一个好的 PR 描述模板可能包含以下几个部分：
- 本次 PR 解决了什么问题？
- 我做了哪些具体的修改？
- 我是如何测试的？
创建 PR：填写完毕后，点击“Create pull request”按钮。