你好,勇敢的探索者!欢迎来到 GitHub 新手村!
这个地方是专门为你准备的在线演练场。你是不是一直听说 Star、Fork、Pull Request 这些词,但感觉很抽象?别担心,在这里,你可以随意操作,弄坏了也没关系!
接下来,请跟随下面的任务指引,一步步完成你在 GitHub 上的“初体验”吧!
YouTube: https://youtu.be/oZaHzvIQ0yw
这是最简单的操作,代表你对一个项目的喜欢和认可。
- 你的任务: 看到页面右上角的 "Star" ⭐ 按钮了吗?毫不犹豫地点击它!
- 作用:
- 相当于给这个项目点了个赞 👍。
- 以后你可以在自己的主页
Stars标签页里快速找到这个项目,就像浏览器的书签一样。
Fork 就像是把别人的东西完美地复制一份,变成你自己的。这样你就可以在你的版本里随意修改,而不会影响到原作者。
- 你的任务:
- 在页面右上角,
Star按钮的旁边,找到 "Fork" 按钮。 - 点击它,然后点击 "Create fork"。
- 稍等片刻,GitHub 就会把这个仓库完整地复制到你的账号下。你会发现页面跳转到了一个和你当前看到的几乎一模一样,但左上角项目名称变成了
你的用户名/GreenHand的新页面。
- 在页面右上角,
恭喜!你现在拥有了这个项目的独立副本!
Issues 是项目的交流中心,大家在这里提问、报告问题、讨论想法。
- 你的任务:
- 回到我们这个原始的
GreenHand仓库页面(而不是你 Fork 走的那个)。 - 点击页面上方的 "Issues" 标签页。
- 点击绿色的 "New issue" 按钮。
- Title (标题): 写上
[新手报到] 来自XXX的问候(把XXX换成你的GitHub用户名)。 - Leave a comment (内容): 简单地做个自我介绍吧!
- 点击 "Submit new issue"。
- 回到我们这个原始的
太棒了!你已经成功地参与到了项目的讨论中。
这是最激动人心的一步!你将亲手修改代码,并请求项目所有者把你做的贡献合并进来。这正是开源协作的核心!
请注意:接下来的所有操作,都在你 Fork 走的那个仓库里进行! (你的用户名/GreenHand)
-
你的任务:
第一步:在线修改文件
- 确保你现在位于你自己 Fork 的仓库里。
- 在文件列表中,找到一个名为
CONTRIBUTORS.md的文件。如果找不到,请创建一个。(点击Add file->Create new file) - 点击这个文件,然后点击右上角的铅笔图标 ✏️ 进入编辑模式。
- 在文件的最后,新起一行,按照下面的格式添加你自己的信息:
例如:
- [你的GitHub用户名](https://github.com/你的GitHub用户名)
- [octocat](https://github.com/octocat)
- 滚动到页面底部,点击绿色的 "Commit changes" 按钮。
第二步:发起 Pull Request
- 完成上面的修改并提交后,回到你 Fork 仓库的首页。
- 你会看到一个黄色的提示条,告诉你你的分支比原仓库有更新。点击右侧的 "Contribute" 按钮,然后选择 "Open pull request"。
- GitHub 会自动帮你填好大部分信息。检查一下,确保是从你的
main分支提交到原始仓库的main分支。 - Title (标题): 默认的标题就很好,比如
Update CONTRIBUTORS.md。 - Leave a comment (内容): 可以简单写一句,比如
Hi, I've added my name to the contributors list!。 - 最后,点击 "Create pull request"。
完成了上面的任务,你已经掌握了核心的协作流程。现在,我们来像游客一样,逛一逛项目页面的其他角落,看看它们都是做什么的。
在项目主页的右侧,你会看到一个 About 板块,这是项目的快速信息卡。
- About (关于): 一句话介绍这个项目是干什么的。旁边通常还有项目的官网链接和一些描述项目属性的
Topics(标签)。 - Releases (发布): 如果这是一个软件项目,
Releases就像是它的“版本发布中心”。开发者会在这里打包好软件的稳定版本(比如v1.0,v2.0),方便用户直接下载使用,而不是去下载一堆源代码。 - Packages (包): 这里是用来存放项目代码包的地方。对于开发者来说,他们可以把写好的代码库(比如一个好用的工具函数)发布到这里,其他开发者就可以方便地在自己的项目里引用和安装这个“包”了。
除了我们已经用过的 Code 和 Issues,顶部还有一些功能强大的标签页。
- Actions (行动): 把这里想象成一个自动化机器人中心。开发者可以预设好一套工作流程(Workflow),比如“当有人提交 PR 时,自动检查代码有没有明显错误”、“当代码合并到主分支后,自动发布一个新版本”。这极大地提高了工作效率,减少了人为失误。
- Projects (项目): 一个内置的项目管理工具。可以创建类似“待办事项”、“进行中”、“已完成”这样的看板,把
Issues和Pull Requests变成一张张任务卡片,拖来拖去,直观地跟踪整个项目的进度。 - Wiki (维基): 如果说
README.md是项目的“快速上手指南”,那么Wiki就是项目的“完整百科全书”。开发者会在这里撰写更详细的设计文档、架构说明、使用教程等。
一旦你完成了第四步,你就完整地体验了在 GitHub 上进行开源协作最核心的流程!我会看到你提交的 Pull Request,并把它合并到项目里。届时,你的名字就会正式出现在这个项目的贡献者列表里了!
欢迎来到开源的世界,这只是一个开始!