6.6 KiB
第一次参与开源项目
| GitKraken 版 |
|---|
万事开头难。特别是当你正与其他人合作的时侯,出错不是一件舒服的事情。不过,开源的本质就是和他人合作。我们想要简化开源初学者第一次学习和贡献的方法。
你可以通过阅读文章和观看教程来得到帮助,但是没有比实际去做而不搞砸更好的方法了。本项目旨在简化并指导初学者参与他们的第一次开源。记住:过程越轻松,学习效益越高。如果你想要做出第一次贡献,只需按照以下简单步骤操作即可。相信我们,这将会是一个有趣的过程 :)
Git Kraken
下载GitKraken,安装并打开它。
你应该会看到 "Welcome to GitKraken" 的对话框。
使用你的GitHub账号登陆并允许GitKraken 访问你的 GitHub 账户。
(可选)点击文件“File” ,选择首选项“Preferences”,将你的项目目录设置为本地存储库的根目录。
Fork(复制)本代码仓库
点击页面顶部的 “Fork” 按钮来分叉(Fork)这个仓库。
这将在你的账户中创建这个存储库的副本。
Clone(克隆)代码仓库
在GitKraken中,点击文件“File” ,选择克隆储存库。
在右侧窗格中选择 ”GitHub.com“。在你的用户名下,你应该看到 “first-contributions”。点击该存储库并查看窗格底部显示的完整路径。
当你确定你想要保存在本地的路径后,点击 “Clone the repo!”。
新建一个代码分支
点击工具栏上的 "分支"(Branch)按钮。
给你的分支命名为 "add-your-name",例如:"add-william-sutton"。
进行必要的更改并提交这些更改
现在在文本编辑器中打开Contributors.md文件并添加您的名字,然后保存文件。
如果你在 GitKraken 中打开了存储库,你会看到有更改。请通过选择最新的提交(标有“// WIP”以及更改的文件数和更改的类型)来审查和暂存这些更改。
审查已更改的文件,并决定哪些文件你想要暂存。暂存很重要,它告诉 Git 哪些文件更改与这次提交相关。
一旦你有了一个不错的提交消息(比如“将 <你的名字> 添加到贡献者列表”,这听起来不错而且描述清楚),并且对你的更改感到满意,你可以点击“暂存所有更改”来暂存所有已修改的内容,或者点击“暂存文件”来暂存单个文件。
如果你改变主意,你可以取消这些更改,或者将它们全部丢弃。
警告:由于"discard"(丢弃)这个词的含义,这是一种破坏性的操作。只有当你不希望保留你所在的仓库中的任何更改时才执行此操作。
点击 commit(提交)
恭喜!你已将所有更改提交到首次贡献分支的本地副本。继续前进吧!
将改动 Push(推送)到 GitHub
点击工具栏上的 "Push" 按钮。
如果你想要更改直接反映在主分支中,就提交更改到源分支。否则,选择你想要推送的适当分支。
提交你的更改供他人审阅
如果你在 GitHub 上进入你的存储库,你会看到Compare & pull request按钮。点击这个按钮。
现在提交拉取请求。
很快我将把你的所有更改合并到这个项目的主分支中。一旦更改已经合并,你将收到通知邮件。
接下来该做什么呢?
恭喜!你刚刚完成了作为贡献者经常遇到的标准“分叉 -> 克隆 -> 编辑 -> 提交请求(PR)”的工作流程!
庆祝你的贡献,并通过前往web app分享给你的朋友和关注者。
如果有任何疑问或想获得更多协助,欢迎加入我们的 Slack!
