README 规范

基本要求

• 仓库必须带有 README.md 文件
• README 部分必须是大写
• 项目如果支持 i18n，项目默认的 README.md 使用中文，其余语言使用如 README.de.md 形式，de 参考 BCP47 标准，优先使用非区域子标记。例如优先使用 README.en.md 而非 README.en-US.md
• 确保是个有效 Markdown 文件

内容

名词避免使用缩写形式，除非官方也广泛使用。如 JavaScript 不应写作 JS；Cross-Origin Resource Sharing 可写作 CORS。

标题

可使用一次或者不使用 1 级标题，当使用时需确保其在 Markdown 正文最前面，但是可以在 HTML 元素之后。

具体章节以 2 级标题（##）开始，可以出现任意多次 2 级和以下等级的标记。

等级必须按顺序依次出现，不能跳级。

长度不应该超过 20 个字符。

徽章

徽章是可选的，使用 Shields 可生成徽章。

代码

确保像在项目的其余部分中对代码进行 linted 一样对它们进行 linted