目录
- 背景
- 第一部分 环境准备
- 第二部分 具体步骤
- 参考文献及资料
背景
GitHub
上就有一个现成的教程项目 first-contributions
,为初学者带来一个简单的方法来学习及参与开源项目。项目地址:
https://github.com/firstcontributions/first-contributions
第一部分 环境准备
部署git
,不再赘述。
第二部分 具体步骤
2.1 fork目标库
点击Fork按钮去 Fork 这个代码仓库。 这样自己的账户中就有一个新库了:git账户/目标库名
2.2 克隆复制库到本地
1 | $ git clone git@github.com:github账户/first-contributions.git |
例如:
1 | $ git clone git@github.com:xiaoming/first-contributions.git |
或者使用https
协议的url
。
1 | $ git clone git@github.com:xiaoming/first-contributions.git |
由于GTW
原因比较慢。
2.3 新建一个代码分支
1 | cd first-contributions |
例如:
1 | git checkout -b add-xiaoming |
2.4 修改并Commit提交
我们只修改主目录下的文件:Contributors.md
,编辑文件,按照格式添加自己的账户信息,保存。
命令行方式:
1 | git add Contributors.md |
提交本地库:
1 | git commit -m "Add xiaoming to Contributors list" |
或者通过github desktop
工具操作更简单。
另外也可以创建翻译文件,例如:addtional-material.chs.md
然后提交。
2.5 提交到github
主库(克隆的库)
1 | git push origin <分支的名称> |
例如:
1 | git push origin add-xiaoming |
或者通过github desktop
工具操作更简单。
2.6 提交到目标库审阅
这时候github
页面会显示:
add-xiaoming had recent pushes 1 minute ago
你会看到一个 Compare & pull request
的按钮。点击该按钮。填写相关信息后正式提交。等待项目人审批后正式合并在目标库中。
参考文章
1、 first-contributions
项目地址:https://github.com/firstcontributions/first-contributions