导论匹配
文档结构规范
标题格式
- 每个文档必须有且仅有一个一级标题(
#), 位于文档开头 - 标题内容必须与Summary和所在章节的README.md对应
- 示例:
# 排序算法
必备章节
- 必须包含
## 练习与回答章节 - 建议使用
---分隔线提升可读性
---
## 练习与回答
代码贡献规范
基本要求
- 使用Rust实现《算法导论》中的伪代码
- 函数命名:
- 参考原书过程命名
- 必须符合Rust命名规范(snake_case)
- 特殊情况需提供替代实现的说明
PR前检查清单
- 代码使用最新稳定版Rust编译通过(无警告)
- 实现原书伪代码逻辑
- 正确处理所有合法输入
- 已通过
rustfmt格式化
进阶建议(非必须但鼓励)
- 提供循环不变式及正确性证明
- 补充相关算法的数学证明
- 添加复杂度分析
- 在章节独有的
.rs文件中提供代码
图片使用规范
格式要求
- 推荐格式: PNG/JPG
- 网络图片:
- 确保来源合法安全
- 必须拥有使用权限
- 本地图片:
- 命名格式: 主文档名_描述_后缀
sorting_algorithm_visualization.png
注意事项
- 优先使用文字描述, 图片仅作为辅助
- 尽量避免提交图片到仓库
- 侵权内容将立即删除
Tip
如有疑问, 请通过issue提出