Skip to content
 
 

Latest commit

 

History

34,270 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open Source Love License: MIT Open Source Helpers

第一次参与开源项目

牢孩子们,万事开头难。特别是和其他人合作时,出错往往会令人不适。不过,开源的本质就是和他人合作。这个项目的初衷就是为了我们大家初学者提供一个简单的方法去学习以及参与开源项目。这个项目也是从别处fork来的,不过这也体现了开源的精神:你想要的东西,在网上都有。

你可以通过阅读文章和观看教程来得到帮助,不过上手实操才是最好的学习方式。本项目旨在简化并指导初学者参与他们的第一次开源。记住:过程越轻松,学习效益越高。如果你想要做出第一次贡献,只需按照以下简单步骤操作即可。这将会是一个很有趣的过程 ,如果你实在不想动,也可以把链接直接丢给AI,告诉他:帮我提交一次PR。等你们提交PR,我会马上合并的,你就会获得开源项目贡献者的称号:)

复制此仓库代码

如果你的电脑上未安装 Git,请参考 GitHub 文档 进行安装。

Fork(复制)本代码仓库

点击图示中的按钮去 Fork 这个代码仓库。 这个操作会将代码仓库复制到你的账户名下。

Clone(克隆)代码仓库

克隆此仓库代码

接下来将复制的代码仓库克隆到你的电脑上。点击图示中的绿色按钮,接着点击复制到剪切板按钮(将代码仓库地址复制下来)。

随后打开命令行窗口,敲入如下 Git 命令:

git clone "刚才复制的 URL 链接"

"刚才复制的 URL 链接"(去掉双引号)就是复制到你账户名下的代码仓库地址。获取该链接的方法详见上一步。

将 URL 链接复制到剪贴板

譬如:

git clone git@github.com:<GitHub用户名>/first-contributions.git

'GitHub 用户名' 指的是你的 GitHub 用户名。这一步,这个操作将会克隆你账户名下 first-contributions 这个代码仓库到本地电脑上。

新建一个代码分支

在命令行窗口中把目录切换到 first-contributions。

cd first-contributions

接下来使用 git switch 命令新建一个代码分支:

git switch -c <新分支的名称>

譬如:

git switch -c add-myname
如果在运行 git switch 时报错,请点击这里:

如果出现错误信息 “Git: switch is not a git command. See git --help”(即提示 switch 不是 git 命令),可能是因为你使用的是旧版本的 Git。

在这种情况下,请尝试改用 git checkout 命令:

git checkout -b <新分支的名称>

(新分支的名称不一定需要有 add。然而,在新分支的名称加入 add 是一件合理的事情,因为这个分支的目的是将你的名字添加到列表中。)

对代码进行修改并提交修改

现在,在文本编辑器中打开 Contributors.md 文件,将你的名字添加到文件中。不要把名字加在文件的开头或结尾,请加在它们之间的任意位置。然后保存文件。

修改`Contributors.md`后的git状态

如果在项目目录下运行 git status 命令,你会看到有文件被修改了。

使用 git add 命令,将这些修改添加到刚才创建的分支中:

git add Contributors.md

现在就可以使用 git commit 命令提交你的修改了:

git commit -m "Add <你的名字> to Contributors list"

<你的名字> 替换成你的名字。

将改动 Push(推送)到 GitHub

使用 git push 命令推送代码:

git push -u origin <新分支的名称>

<新分支的名称> 替换为之前新建的分支名称。

如果在推送(push)过程中出现错误(error),点击这里:
  • Authentication Error

    remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.
    remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information.
    fatal: Authentication failed for 'https://github.com/<your-username>/first-contributions.git/'

    GitHub 教程 学习如何生成新的 SSH 密钥并进行配置。

    另外,你可能需要运行 git remote -v 来检查你的远程仓库地址。

    如果它看起来像这样:

    origin	https://github.com/your-username/first-contributions.git (fetch)
    origin	https://github.com/your-username/first-contributions.git (push)

    请使用以下命令进行修改:

    git remote set-url origin git@github.com:your-username/first-contributions.git

    否则你仍会被要求输入用户名和密码,从而导致认证错误。

提出 Pull Request 将你的修改供他人审阅

前往你的 GitHub 代码仓库,你会看到一个 Compare & pull request 的按钮。点击该按钮。

创建 pull request

接着再点击 Create pull request 按钮,正式提交 pull request。

提交 pull request

我们就会把你所有的修改合并到这个项目的 main 分支。更改合并后,你会收到一封电子邮件通知。

接下来该做什么呢?

祝贺!你刚刚完成了作为贡献者经常会使用到的标准流程:fork -> clone -> edit -> pull request

为你的第一次贡献庆祝吧,不要忘记和你的朋友以及你的关注者分享我们的QQ群417879056哟!

如果你想进行更多练习,请查看 code contributions

接下来,让我们带你开始参与到其他项目中来。我们整理了一份包含一些简单入门问题的项目清单,方便你快速上手。请查看这个 项目清单

About

🚀✨ Help beginners to contribute to open source projects

Resources

Stars

6 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages