PR规范

标准流程

首先获取已有内容，您可以尝试 Fork 当前仓库，然后克隆自己的新仓库，接着像您为别的仓库提供PR一样即可。

或者，直接在Github中修改内容并提交。

根据《算法导论》的相关内容，设计章节和准备代码，接着用中文书面语表述出来。在这里您可以有自己的语言习惯，但不要过于口语化，使用朴素的陈述口气会更符合本书一贯的风格。( 但如果您想要这样的也可以哦:)

首先不要一律照搬《算法导论》相关内容，任何伪代码都不应该在本书中出现。本书的定位是一本轻教材，但一般的话，您可以把它理解为一本学习笔记。编写本书的时候贯彻教学相长的思想，参考其他的章节，您可以领会到这种意味。

其次，应该使用Rust语言来完成伪代码，对于不太严格的完成，需要解释原因，但同时要保证本书的知识点。如果因为对伪代码不太严格的完成导致知识点被忽略，应该自然地衔接补充。

这里介绍的是如何创建新文档。

首先要明确非必要不引入新文档，如有必要按照特殊情形。

文档与算法导论相对应。通常1~3个文档与算法导论的一节大知识相对应。部分特殊文档(如本文档之类的)一般在前期工作就被创建，且后期将不能再创建。您可以合理的分割算法导论的一节大知识，以准备编写。通常不建议跨章节创建文档(即上一个章节还没完全创建下一个章节的内容)。

接下来需要给定名称，章节名总是由作者给定，但单个文档名可以您来给定。一般需要一个英文名(仅包含小写字母和下划线)和一个中文名称。在src/SUMMARY.md中找到合理的位置，放置您的文档，格式参考SUMMARY.md。

该行为容易导致文档崩溃，在没有前期经验的情况下，很容易出错。所以我们将其归为不推荐行为。

完成之后，提交即可(对于空文档请参考文档补充)。

注: 一般来说我们也推荐在您提交文档所在章节的README.md中放置索引。

如果您在编写文档的过程中，认为编写周期过长(比方说准备长期的空文档)，那么可以先停下来，在合理的位置留下下面这个注:

> 该章节仍在编写，在 [Github仓库](https://github.com/TickPoints/algorithm_learning) 上提交PR以为本书 [贡献内容](/pr_guide/pr_standard.md)。

接着提交PR即可。

如果您是想为本书进行补充，那么直接在当前页面点击标签栏的Edit图标就可以直接进入编辑模式(或是参考标准流程)。

Edit图标

补充或修改一般是较小行为，不建议大动作的更改(如果您需要一个标准，那么80行以上的更改可以被称为这个)，这类PR一般会被快速通过。

严格的可以参考导论匹配，一般情况下阅读前面的文档就够了。

不推荐行为:

在编写中，我们常常不应进行上面提到的任何一个不推荐行为，在没有必要的情况下，永远不要去做它们。但如果有必要，您就要遵循这些规则:

任何不推荐行为的PR，都应该事先说明。如果您做了这些不推荐行为，必须在提交的时候告知。
任何不推荐行为的PR，都需要issue作支持，您可以自己提issue或是使用他人的issue。issue提出的一段合理时间后再进行PR。在这段过程中，简单的行为或不应当的行为可能会被指出。对于简单的行为(如仅仅只是创建一个空的新页面)，其它作者将帮助您完成。而对于不应当的行为，您就不能进行PR，保持冷静对待，可以尝试迂回的解决，这可以避免不必要的麻烦。(一定记得等段一段适当时间，防止在PR提出之后才被否决，造成浪费)