docker_practice/CONTRIBUTING.md

42 lines
1.2 KiB
Markdown
Raw Normal View History

2017-01-12 05:25:22 +00:00
## 如何贡献项目
2017-12-04 03:49:59 +00:00
2017-12-06 13:43:01 +00:00
领取或创建新的 [Issue](https://github.com/yeasy/docker_practice/issues),如 [issue 235](https://github.com/yeasy/docker_practice/issues/235),添加自己为 `Assignee`
2017-01-12 05:25:22 +00:00
2017-12-06 13:43:01 +00:00
在 [GitHub](https://github.com/yeasy/docker_practice/fork) 上 `fork` 到自己的仓库,如 `docker_user/docker_practice`,然后 `clone` 到本地,并设置用户信息。
2017-01-12 05:25:22 +00:00
2017-12-06 13:43:01 +00:00
```bash
$ git clone git@github.com:docker_user/docker_practice.git
2017-12-31 06:32:22 +00:00
2017-12-06 13:43:01 +00:00
$ cd docker_practice
```
2017-01-12 05:25:22 +00:00
2017-12-06 13:43:01 +00:00
修改代码后提交,并推送到自己的仓库,注意修改提交消息为对应 Issue 号和描述。
2017-01-12 05:25:22 +00:00
2017-12-06 13:43:01 +00:00
```bash
# Update the content
2017-12-31 06:32:22 +00:00
2017-12-06 13:43:01 +00:00
$ git commit -a -s
2017-12-31 06:32:22 +00:00
2017-12-06 13:43:01 +00:00
# In commit msg dialog, add content like "Fix issue #235: describe ur change"
2017-12-31 06:32:22 +00:00
2017-12-06 13:43:01 +00:00
$ git push
```
2017-01-12 05:25:22 +00:00
2017-12-06 13:43:01 +00:00
在 [GitHub](https://github.com/yeasy/docker_practice/pulls) 上提交 `Pull Request`,添加标签,并邀请维护者进行 `Review`
2017-01-12 05:25:22 +00:00
2017-12-06 13:43:01 +00:00
定期使用项目仓库内容更新自己仓库内容。
2017-11-24 03:31:22 +00:00
2017-12-06 13:43:01 +00:00
```bash
$ git remote add upstream https://github.com/yeasy/docker_practice
2017-12-31 06:32:22 +00:00
2017-12-06 13:43:01 +00:00
$ git fetch upstream
2017-12-31 06:32:22 +00:00
2017-12-06 13:43:01 +00:00
$ git rebase upstream/master
2017-12-31 06:32:22 +00:00
2017-12-06 13:43:01 +00:00
$ git push -f origin master
```
2017-01-12 05:25:22 +00:00
## 排版规范
本开源书籍遵循 [中文排版指南](https://github.com/mzlogin/chinese-copywriting-guidelines) 规范。