Skip to content

Latest commit

 

History

History
156 lines (90 loc) · 2.6 KB

CONTRIBUTING.md

File metadata and controls

156 lines (90 loc) · 2.6 KB

说明

感谢参加编辑!

下面是一个简短的中文指南和英文指南

先确保您的内容符合 Github 条款

指南

准确明白为第一,覆盖度第二。

大的改动

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

页面 Todo

>Todo 
>
>
>
>
>

添加内容

Commit 信息日志

能写详细就写详细

阅读友好

考虑读者感受

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

比如

问题
短回答

应该改成 如果xxx,读 xxx

格式化

不要对内容格式化,合并时审视内容改动很困难。

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

共同的文档

黑话

偏僻别名不应该出现。

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

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

重要章节放在前面

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

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

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


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

### 下一个内容


Guide

Accuracy is understood first, coverage second.

Make sure your content complies with Github terms first

Major changes

Please start with an Issue or Pull Draft for clarification so that others know you are working on this lengthy project.

Page Todo

>Todo 
>
>
>
>
>

Add content

Commit message log

Write as much detail as you can

Read friendly

Consider the reader's feelings

Eliminate unnecessary question and answer turns

For example

Questions
Short answers

should be changed to If xxx, read xxx

formatting

Do not format the content, it is difficult to review the content changes when merging.

If needed, mention a specific item for formatting optimization.

Common documents

Term

Offbeat aliases should not appear.

In application chapters, it is best to avoid jargon.

In the theoretical introduction, use standard terminology that is the norm for the document.

Important chapters at the front

The higher the frequency, the more important the information should be at the front.

If the content is only links, please include a landing page at the end

Please don't throw in content like this, but introduce the basic information.


### Added content
[content link]()

### Next content