导论匹配
下面所介绍的内容均是指正式文档(不包括引言和PR贡献指南)
结构(标题格式)
每一个文档只允许有且只有一个主标题,即直接使用单个#
引导的标题,如:
# 导论匹配
这个标题必须在文档开头,且总是要求与Summary
相对应。一般来说还与当前所在章节的README.md
中的内容相对应,如:
# PR贡献指南
通过以下文档了解如何贡献:
- [文档语法](./document_syntax.md)
- [PR规范](./pr_standard.md)
- [导论匹配](./introductory_match.md)
剩下的标题中必须有## 练习与回答
,推荐在前面加上---
用来分割,如:
---
## 练习与回答
此外所有的代码实现都必须冠以标题,如:
### 实现一
代码格式
像PR规范中所说的那样,应该使用Rust语言来完成《算法导论》中的伪代码,对于特殊情况可以尝试迂回的实现。
对于一个实现的主函数,必须以realizeX
命名(当X
为1
,允许省略)。附函数(如辅助函数)可以参照《算法导论》中的过程命名,但必须要符合Rust命名规范。
在PR前,您要保证:
- 您的代码在最新稳定的Rust编译器下通过编译,且不出现警告。
- 您的代码完成了《算法导论》中的伪代码逻辑。
- 您的代码能够对所有的输入得到一个有效的输出。
- 您的代码已经过格式化。
如果您能实现上面这些,将不胜感激。(注: 我们也推荐你能给出代码的循环不变式并证明以此证明算法正确性。同时对于部分文档需要给出证明,也可以避免其他作者额外的工作)
图片格式
任何可以渲染的图片均可,一般来说推荐.png
、.jpg
(.jpeg
),如果是网络照片(通过URL获取)请确保是合理安全来源,且拥有使用权限。如果是本地照片(提交到仓库),要求符合以下命名格式:
对照文章(如有多篇取最重要的一篇)_图片意义(尽量短小)_后缀
如:
introductory_match_example.jpg
其次需要提前对图片进行压缩,然后随着PR提交即可。要注意这是不推荐行为。
如有侵权请联系,我们将马上删除照片。