From 0c4c907748966f9abf979075ff5afdd576c0d7ff Mon Sep 17 00:00:00 2001 From: lincc <46962923+blueskyson@users.noreply.github.com> Date: Sat, 7 Aug 2021 01:31:33 +0800 Subject: [PATCH] style-guide: add Chinese-specific rules (#6285) --- contributing-guides/style-guide.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index c1e7c9ab90..b86566f2c2 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -78,6 +78,7 @@ Use backticks on the following: 3. Commands, ex. `ls`. ## Serial Comma + When declaring a list of 3 or more items, use a [serial comma](https://en.wikipedia.org/wiki/Serial_comma), also known as the Oxford comma. When the serial comma is ommitted, it can create ambiguity. @@ -91,3 +92,26 @@ The example above does not use a serial comma, so this could mean one of two thi This can be resolved by inserting a comma before the "and" or "or" in the final element in the list. > Delete the Git branches, tags, and remotes. + +## Chinese-Specific Rules + +When Chinese words, Latin words and Arabic numerals are written in the same sentence, it takes more attention to copywriting. + +The following guidelines are applied to Chinese (zh) and traditional Chinese (zh_TW): + +1. Place one space before/after English words and numbers. + For example, use `列出所有 docker 容器` rather than `列出所有docker容器`. + For example, use `宽度为 50 个字` rather than `宽度为50个字`. +2. Place one space between numbers and units **except** degrees and percentages. + For example, use `容量 50 MB` rather than `容量 50MB`. + For instances of degree and percentage, use `50°C` and `50%` rather than `50 °C` and `50 %`. +3. No additional spaces before/after full-width punctuations. + For example, use `开启 shell,进入交互模式` rather than `开启 shell ,进入交互模式` +4. Use full-width punctuations except for long Latin clauses. + For example, use `嗨,你好。` rather than `嗨, 你好.` +5. Use precise form for technical terms, and do not use unofficial Chinese abbreviations. + For example, use `Facebook` rather than `facebook`, `fb` or `脸书`. + +In order to maintain readability and normalization, please comply the 5 rules above as much as possible when translating pages into Chinese. + +For more information and examples of Chinese-specific rules, check out [*Chinese Copywriting Guidelines*](https://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/README.en-US.md). \ No newline at end of file