From 33662042fc2aa44e1e5c5d483243a2a73e50941a Mon Sep 17 00:00:00 2001 From: Kerminate Date: Thu, 1 Aug 2019 04:30:15 +0800 Subject: [PATCH] docs: Readme TOC (#37224) * feat: create README.cn.md * chore: add Chinese README * feat: Switch status badges to Azure Pipelines in README.cn.md * docs: Readme TOC --- README.cn.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.cn.md b/README.cn.md index 8c4cf7c001..5d31d9fe43 100644 --- a/README.cn.md +++ b/README.cn.md @@ -6,6 +6,19 @@ *你可以去看其他语言的 README,[英语](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md),[西班牙语](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.es.md),[韩语](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.ko.md),[俄罗斯语](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.ru.md)* +## 目录 + +* [当前状态](#当前状态) +* [我该如何贡献?](#我该如何贡献) + * [测试](#测试) + * [发起一个 pull request](#发起一个-pull-request) + * [编辑一个现有包](#编辑一个现有包) + * [创建一个新的包](#创建一个新的包) + * [常见错误](#常见错误) + * [删除一个包](#删除一个包) + * [Lint](#lint) +* [FAQ](#faq) + ## 当前状态 这个部分会跟踪仓库和发布过程的运行状况。 @@ -139,7 +152,7 @@ Definitely Typed 的成员会定期查看新的 PRs,但是请记住当有许 #### 常见错误 * 首先,请遵循 [手册](http://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html) 的建议。 -* 格式化:要么全部使用 tabs,要么始终使用 4 个空格。 +* 格式化:使用4个空格。 对于新代码,这由 Prettier 强制执行。 * `function sum(nums: number[]): number`: 如果函数没有写入的参数,请使用 `ReadonlyArray`. * `interface Foo { new(): Foo; }`: 这定义了一个可实例化的类型,你可能需要的是 `declare class Foo { constructor(); }`.