This is an automated email from the ASF dual-hosted git repository.
duanzhengqiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new f19975b0568 Create document-conduct.md (#20010)
f19975b0568 is described below
commit f19975b05684e0c1fb1836d95b63488d40d285ee
Author: Mike0601 <[email protected]>
AuthorDate: Tue Aug 9 13:56:39 2022 +0800
Create document-conduct.md (#20010)
* Create document-conduct.md
* Update document-conduct.md
* Update and rename document-conduct.md to document-conduct.cn.md
---
.../community/content/contribute/document-conduct.cn.md | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/docs/community/content/contribute/document-conduct.cn.md
b/docs/community/content/contribute/document-conduct.cn.md
new file mode 100644
index 00000000000..854d955e402
--- /dev/null
+++ b/docs/community/content/contribute/document-conduct.cn.md
@@ -0,0 +1,17 @@
++++
+title = "文档规范"
+weight = 6
+chapter = true
++++
+
+- 每个 Topic 不用写标题,GitHub 支持标题的自动生成。
+- 每个表格要严格按照表格样式排版,以便后续人员看清楚和接手。
+- 段落的句号结尾要换行,否则会造成某段落太长。
+- 每个 Topic 的结尾留一空行。
+- 每个 Topic 里面的 Title 前要空行。
+- 每个 Topic 的文件名命名要有意义。
+- 英文文档不要使用中文字符。
+- 每个表头的 | 和 - 之间要加一个空格。
+- 操作步骤均使用 `1.` 可自动生成序号。
+- Item List 前面都用“;”结尾,最后一项用“。”结尾。
+- 中英文之间需要增加空格。