Skip to content

Commit

Permalink
Add code of conduct
Browse files Browse the repository at this point in the history
  • Loading branch information
rootsongjc committed Mar 10, 2019
1 parent 891bb95 commit 47c0167
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 3 deletions.
48 changes: 48 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# 本书写作规范

本文中指定了本书的写作规范与注意事项。

## 文档组织规则

- 所有文档使用 markdown 格式撰写;
- 文中的图片直接使用**新浪图床**保存,不用保存在GitHub 上;
- 所有代码需要指明语言;

## 流程

1. 首先加入到 [ServiceMesher](https://github.com/servicemesher) 组织中,请联系 [Jimmy Song](https://jimmysong.io/about) 加入;
2.[Issues](https://github.com/servicemesher/getting-started-with-knative/issues) 中创建你想要参与的章节(issue 标题为文章路径,内容填写标题和摘要);
3. 一次最多同时认领或提交 3 个 PR;
4. 由 owner 审核后 merge 进 master 分支;
5. 每篇文章头部的 header 请注意填写;
6. 每周将使用 GitHub pages 发布一次;

## Header

每篇文章的头部都有一个使用 YAML 格式的 header,请在每次提交 PR 的时候填写,示例:

```yaml
owners: ["rootsongjc","loverto"]
reviewers: ["fleeto","mathlsj"...]
description: "文章摘要。"
publishDate: 2019-03-02
updateDate: 2019-03-10
tags: ["tagA","tagB"...]
category: "translation|original|evolution"
```
**说明**
- owners:原则上不超过2人;
- reviewers:只要修改过文章都人都是 reviewer;
- description:本文章的摘要,不要超过200字;
- publishDate:文章第一次合并的日期;
- updateDate:最新一次修改的日期;
- tags:文章中出现的关键词;
- category:translation(翻译的文章),original(原创文章),evolution(在翻译文章的基础上重新演绎,对原文有大量更新);
## 排版规范
- 所有的英文跟中文之间要有一个空格;
- 参阅 [Istio 网站样式指南](https://istio.io/zh/about/contribute/style-guide/);
- 专有名词中文译名参阅 <https://github.com/servicemesher/glossary>;
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Istio Service Mesh Advanced Practical - Master the Services in Post Kubernetes E
## 版权

<p align="center">
<a href="https://jimmysong.io/istio-handbook">
<img src="cover.jpg" width="40%" alt="Istio handbook - istio服务网格实践指南" />
<a href="http://www.servicemesher.com/istio-handbook">
<img src="cover.jpg" width="40%" alt="Istio handbook - Istio 服务网格进阶实战" />
</a>
</p>

Expand All @@ -24,7 +24,7 @@ Istio Service Mesh Advanced Practical - Master the Services in Post Kubernetes E

## 参与本书

参与本书的撰写,请先加入 [ServiceMesher 社区](http://www.servicemesher.com/contact) 并参阅 [Istio 网站样式指南](https://istio.io/zh/about/contribute/style-guide/)
请参阅[本书写作规范](CODE_OF_CONDUCT.md),加入 ServiceMesher 后进入 Slack channel 讨论

## ServiceMesher 社区

Expand Down

0 comments on commit 47c0167

Please sign in to comment.