CONTRIBUTING.md

指南

NO废话，准确明白为第一，覆盖度第二，也很重要。

协作公开进度，issue 或者 pull

大的改动

请先提 Issue 或者 Pull Draft 进行一个说明，便于其他人知道你正在进行这项长时间的工作

页面 Todo

>此页面注释或者使用Html注释

>Todo 
>
>
>
>
>

添加内容

Commit 信息

能写就写

阅读友好

取消一些不必要的问答转弯形式

比如

问题
短回答

应该改成 如果xxx，读 xxx

格式化

别格式化，定位内容改动很困难。

需要的话，请专门提一项进行格式优化。

不要夹带大量私货

黑话

炼丹这类的别名应该被文档禁止。

在应用章节，最好不要用术语。

在理论介绍，要使用标准术语，是文档的规范。

重要章节放在前面

越高频，重要的信息应该越靠前。

如果内容只有链接，请加入 末尾的落地页

请不要丢这样的内容，要介绍基本信息。

### 增加的内容
[内容链接]()

### 下一个内容