首次贡献

如何为开源项目做出你的首次贡献?#

在开始之前,请确保你拥有以下内容

  • 一个 GitHub 账户
  • 一个终端或命令行
  • 一个编辑器或 IDE
  • Git 安装在你的电脑上
  • Conda 安装在你的电脑上

视频下方有一些链接,可以帮助你准备好这些元素,以防你缺少某些元素。

现在,我们可以开始了。

步骤 1:Fork 项目的仓库#

转到项目的仓库,并点击页面左上角的“Fork”按钮。这将在你自己的账户中创建一个仓库副本。

步骤 2:克隆你的 Fork#

在你的新 Fork 上,点击绿色的“Code”按钮,并复制那里出现的链接以获取克隆它的 URL。

现在,打开你的终端(或 Git Bash,如果你为 Windows 安装了 Git)并键入命令 git clone,然后粘贴你刚刚复制的 URL。这样,你就有了一个 Fork 的本地副本。

最后,切换到刚刚克隆的仓库的目录,并将项目的仓库添加为“上游”远程仓库,方法是键入以下内容

git remote add upstream https://github.com/organization-name/project-name.git

步骤 3:设置你的开发环境#

大多数开源项目都有自己的贡献者指南,其中说明了设置开发环境所需的步骤。你通常可以在仓库的根目录中找到它们。我们建议你为此创建一个新的环境。

要创建和激活一个新的 Conda 环境,请在你的终端(或 Windows 上的 Anaconda Prompt)中键入以下命令

conda create -n [NAME] python=3
conda activate  [NAME]

创建新的 Conda 环境后,你需要安装项目必要的依赖项(这取决于我们将在此视频中使用的项目)

conda install …

步骤 4:选择一个问题#

现在我们需要在问题选项卡(在此处添加项目问题跟踪器的链接以在视频中显示)仓库的问题跟踪器中选择我们要修复的问题,并在项目的开发版本中重现它。(不确定这是否适用,再次强调,这取决于项目)

步骤 5:为你的更改创建一个新分支#

首先为你的工作创建一个分支。在你的命令行中运行以下命令

git checkout -b [BRANCH NAME]

步骤 6:找到文件并进行更改#

在需要解决问题的文件中打开你的编辑器或 IDE,并保存你的更改。

步骤 7:确认/测试问题是否已在开发模式下解决#

(不确定这是否适用)

步骤 8:提交你的更改#

现在,你已准备好添加并提交你的更改,并附带描述性消息。在你的终端中键入以下命令

git commit -a -m “descriptive message”

最后,将你的新分支与你的更改一起推送到 GitHub 上的 Fork。

git push -u origin [BRANCH NAME]

如果被要求,请输入你的 GitHub 用户名和密码。

注意

每次运行 git push 时都要输入你的用户名和密码可能会很麻烦!幸运的是,GitHub 允许你使用 SSH 密钥来自动进行身份验证。基本上,这涉及创建两个特殊文件:一个保存在你的电脑上,另一个上传到 GitHub。如果你想设置它,请查看此处

你也可以使用 gh 命令行工具设置 SSH 密钥:https://cli.githubdocs.cn/manual/ 如果你更喜欢。Mac 和 Windows 用户(但 Linux 用户除外!)如果他们更喜欢通过 GUI 使用 git,则可以使用 GitHub Desktop 应用程序 管理身份验证。

步骤 9:打开 PR#

现在,你可以将你的更改提交到项目的仓库。

转到 Github 上的项目仓库,你将看到打开拉取请求的选项。你还必须确保选择了正确的分支来合并你的更改。

你现在已为开源项目做出了你的首次贡献!

本页面