如何为一个 GitHub 仓库做贡献
前置知识
在为 GitHub 仓库做贡献前,你需要先了解
-
(可选 推荐)Markdown 的基本语法
-
Git 的使用方法(不熟悉可以用 GitHub Desktop 代替,能满足
一点点大部分需求)
你需要拥有一个 GitHub 账号,并且可能需要学会一些科学上网的手段
在你的/你合作的仓库
你当然可以直接向 master/main
分支提交代码,但是通常不建议这么做,这样会让使用你的仓库或者想要对你的仓库做出贡献的人非常难受。
正确的做法是在需要修改的分支 origin-branch
上新建一个分支 your-branch
,这个分支的名字可以代表你需要做的事情(至少有点含义,起码不要是 001
abcd
这种),然后签出到新建的分支上进行更改。
你可以向你新建的分支 Commit
,每个 Commit
通常只完成一个工作(比如配置了 xxx 东西,修复了 xxx 问题)。如果你一次性完成了多项工作,你应当为每一项工作创建一个 Commit
,而不是把所有的东西一股脑用一个 Commit
提交(不要学我之前干的事情)
当你完成了所有需要干的事情之后,希望合并到主分支 master/main
你需要新建一个 Pull request
选择将当前分支 your-branch
合并到 origin-branch
,并在该 Pull request
中说明你的一系列 Commit
完成的工作(或者是这一个 Pull request
完成了什么事情)
在 Pull request
创建之后,GitHub
可能会基于仓库配置自动运行一些 Check
来保证你的代码不会影响整个程序的正常工作,仓库的所有者或者其他合作者可以查看你的 Pull request
并发表评论。当别人发现你的代码存在一些问题,他 / 她可以在存在问题的地方发起一个 Review
,在你处理了这个问题后可以关闭这个 Review
这一块我现在也不是特别熟悉,之后会继续更新
当 Pull request
中的代码检查完毕后,仓库的管理员可以将其 Merge
,即合并到 origin-branch
,至此,你对本仓库的一次贡献就完成了
在一些开源仓库
首先你应当将这个开源仓库 fork
到你自己的账户下,并新建一个分支。
接下来与在你的/你合作的仓库工作时的步骤一致