diff --git a/docs/CONTRIBUTING-zh.md b/docs/CONTRIBUTING-zh.md index cb6ffd965..ef8286bc8 100644 --- a/docs/CONTRIBUTING-zh.md +++ b/docs/CONTRIBUTING-zh.md @@ -291,3 +291,63 @@ - 您可以指定多个要检查的文件,使用单个空格分隔每个条目。 - 如果您指定了多个文件,构建的结果将基于最后一个检查的文件的结果。您应该注意,由于这个原因,您可能会得到通过的绿色构建,所以请确保在拉取请求结束时检查构建日志,点击 “Show all checks”->“Details”。 + + +### 示例 + +``` +* [另一本很棒的书](http://example.com/book.html) +* [其他书籍](http://example.com/other.html) +``` + +- 不要在 `]` 和 `(` 之间加空格: + + ```text + 错误 : * [另一本很棒的书] (http://example.com/book.html) + 正确 : * [另一本很棒的书](http://example.com/book.html) + ``` + +- 如果包含作者,请使用 ` - `(前后各一个空格的短横线): + + ```text + 错误 : * [另一本很棒的书](http://example.com/book.html)- 张三 + 正确 : * [另一本很棒的书](http://example.com/book.html) - 张三 + ``` + +#### 添加许可证说明(分步指南) + +当资源以免费/开放许可证分发时,在格式说明后的括号中添加简短的许可证说明。请按以下步骤操作: + +1. 确认资源页面上的许可证 + - 查找页面底部、"关于"页面或许可证/法律部分 + - 仅对免费/开放内容许可证添加许可证说明(参见上面支持的列表)。不要添加"保留所有权利"等说明 +2. 将许可证字符串规范化为支持的缩写之一 +3. 在 PR 中添加说明,说明您为何认为该资源是免费的 + +### 修复 RTL/LTR linter 错误 + +如果您运行 RTL/LTR Markdown Linter(针对 `*-ar.md`、`*-he.md`、`*-fa.md`、`*-ur.md` 文件)并看到错误或警告: + +- **LTR 词**(如"HTML"、"JavaScript")出现在 RTL 文本中:在每个 LTR 片段后立即附加 `` +- **LTR 符号**(如"C#"、"C++"):在每个 LTR 符号后立即附加 `` + +#### 示例 + +**错误** +```html +