add how to contribute link

pull/148/merge
rootsongjc 2018-03-12 15:45:49 +08:00
parent d475c9cf96
commit 4f04f5031b
1 changed files with 2 additions and 27 deletions

View File

@ -64,39 +64,14 @@ gitbook pdf . ./kubernetes-handbook.pdf
pandoc --latex-engine=xelatex --template=pm-template input.md -o output.pdf pandoc --latex-engine=xelatex --template=pm-template input.md -o output.pdf
``` ```
## 如何贡献
### 提 issue
如果你发现文档中的错误,或者有好的建议、不明白的问题、不要犹豫,欢迎[提交issue](https://github.com/rootsongjc/kubernetes-handbook/issues/new)。
### 发起 Pull Request
当你发现文章中明确的错误或者逻辑问题在你自己的fork的分支中创建一个新的branch修改错误push 到你的branch然后在[提交issue](https://github.com/rootsongjc/kubernetes-handbook/issues/new) 后直接发起Pull Request。
### 贡献文档
#### 文档的组织规则
- 如果要创建一个大的主题就在最顶层创建一个目录;
- 全书五大主题,每个主题一个目录,其下不再设二级目录;
- 所有的图片都放在最顶层的 `images` 目录下,原则上文章中用到的图片都保存在本地;
- 所有的文档的文件名使用英文命名,可以包含数字和中划线;
- `etc`、`manifests`目录专门用来保存配置文件和文档中用到的其他相关文件;
#### 添加文档
1. 在该文章相关主题的目录下创建文档;
2. 在 `SUMMARY.md` 中在相应的章节下添加文章链接;
3. 执行 `gitbook serve` 测试是否报错,访问 http://localhost:4000 查看该文档是否出现在相应主题的目录下;
4. 提交PR
## 关于 ## 关于
感谢以下所有的贡献者! 感谢以下所有的贡献者!
[贡献者列表](https://github.com/rootsongjc/kubernetes-handbook/graphs/contributors) [贡献者列表](https://github.com/rootsongjc/kubernetes-handbook/graphs/contributors)
[查看如何贡献](https://github.com/rootsongjc/kubernetes-handbook/blob/master/CONTRIBUTING.md)
## Stargazers over time ## Stargazers over time
[![Stargazers over time](https://starcharts.herokuapp.com/rootsongjc/kubernetes-handbook.svg)](https://starcharts.herokuapp.com/rootsongjc/kubernetes-handbook) [![Stargazers over time](https://starcharts.herokuapp.com/rootsongjc/kubernetes-handbook.svg)](https://starcharts.herokuapp.com/rootsongjc/kubernetes-handbook)