Follow GitHub recommended community standards

This commit is contained in:
khs1994
2017-11-13 19:35:41 +08:00
parent d1a640f383
commit cb21e9b167
5 changed files with 63 additions and 5 deletions

33
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,33 @@
## 如何贡献项目
* 在 GitHub 上 `fork` 到自己的仓库,如 `docker_user/docker_practice`,然后 `clone` 到本地,并设置用户信息。
```bash
$ git clone git@github.com:docker_user/docker_practice.git
$ cd docker_practice
$ git config user.name "yourname"
$ git config user.email "your email"
```
* 修改代码后提交,并推送到自己的仓库。
```bash
$ #do some change on the content
$ git commit -am "Fix issue #1: change helo to hello"
$ git push
```
* 在 GitHub 网站上提交 pull request。
* 定期使用项目仓库内容更新自己仓库内容。
```bash
$ git remote add upstream https://github.com/yeasy/docker_practice
$ git fetch upstream
$ git checkout master
$ git rebase upstream/master
$ git push -f origin master
```
## 排版规范
本开源书籍遵循 [中文排版指南](https://github.com/mzlogin/chinese-copywriting-guidelines) 规范。

47
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,47 @@
### your OS
<!--请选择你的系统版本-->
<!--select your os version-->
* [x] Linux
* [x] CentOS 7
* [ ] Ubuntu 14.04
* [ ] Ubuntu 16.04
* [ ] Ubuntu 17.04
* [ ] Ubuntu 17.10
* [ ] CoreOS
* [ ] Debian 7.7
* [ ] Debian 8
* [ ] Debian 9
* [ ] macOS
* [ ] Windows 10
### Docker CE Version
<!--如果你的 Docker 版本低于 17.09 请尽可能升级到该版本-->
<!--if Docker version under 17.09, please upgrade Docker to 17.09-->
* [x] 17.10 edge
* [ ] 17.09 stable
* [ ] 1.13.0
* [ ] 1.8.0
### Problem description
<!--描述你的问题,请贴出终端报错截图-->
<!--describe problem-->

11
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,11 @@
<!--Thanks for your contribution. See [CONTRIBUTING](CONTRIBUTING.md)
for this project's contribution guidelines. Remove these comments
as you go. -->
### Proposed changes (optional)
<!--Tell us what you did and why-->
### Fix issues (optional)
<!--Tell us what issues you fixed-->