You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by du...@apache.org on 2022/08/09 05:57:16 UTC

[shardingsphere] branch master updated: Create document-conduct.en.md (#20012)

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 0317922553a Create document-conduct.en.md (#20012)
0317922553a is described below

commit 0317922553a6bea2d66984e70531006ba4c93980
Author: Mike0601 <40...@users.noreply.github.com>
AuthorDate: Tue Aug 9 13:57:11 2022 +0800

    Create document-conduct.en.md (#20012)
---
 .../community/content/contribute/document-conduct.en.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/community/content/contribute/document-conduct.en.md b/docs/community/content/contribute/document-conduct.en.md
new file mode 100644
index 00000000000..5d3fa6c3437
--- /dev/null
+++ b/docs/community/content/contribute/document-conduct.en.md
@@ -0,0 +1,17 @@
++++
+title = "Document Specification"
+weight = 6
+chapter = true
++++
+
+- Each topic does not need to write a title. GitHub supports the automatic generation of titles.
+- Each table shall be arranged in strict accordance with the table style so that follow-up personnel can see clearly and take over.
+- The end of the period of a paragraph should be wrapped, otherwise a paragraph will be too long.
+- Leave a blank line at the end of each topic.
+- There should be a blank line before the title in each topic.
+- The file name of each topic should be meaningful.
+- Do not use Chinese characters in English documents.
+- A space shall be added between | and - in each header.
+- The sequence number can be automatically generated by using '1.'.
+- Item list is preceded by ';' at the end, the last item is marked with "." ending.
+- Spaces need to be added between Chinese and English.