PR规范

标准流程

获取代码

1. 推荐方式: Fork本仓库到您的GitHub账户, 然后克隆到本地进行修改
2. 快捷方式: 直接在GitHub网页界面编辑文件(适合小修改)

如何编辑

内容创作指南

• 内容定位: 本书是《算法导论》的中文Rust实现版学习笔记, 风格应介于教材和笔记之间
• 语言要求:
• 使用规范的中文书面语
• 避免过度口语化, 但应保持朴素、清晰的陈述风格
• 代码规范:
• 所有算法必须用Rust实现
• 禁止直接使用原书伪代码
• 对与伪代码有差异的实现需说明原因
• 确保核心知识点不因实现差异而缺失

目录管理

基本原则:

• 非必要不新增文档
• 文档划分应与《算法导论》章节结构对应
• 通常1-3个文档对应原书一节内容
• 禁止跨章节创建文档(需完成当前章节后再继续)
• 大章节一般要有postscript.md(补充Rust的语法知识和历史信息)和improve.md(与《算法导论》的思考题相对应)

操作步骤:

1. 在src/SUMMARY.md中确定位置
2. 按格式添加文档条目(参考SUMMARY.md规范)
3. 同时更新所在章节的README.md索引

命名规范:

• 英文名: 全小写, 用下划线连接(例: sort_algorithms)
• 中文名: 简洁明确的标题

Warning

不当的目录修改可能导致文档系统崩溃, 新手请谨慎操作

文档补充

临时占位: 如果文档需要长期编写, 可添加如下占位说明:

> [!WARNING]
> 该章节仍在编写, 欢迎在 [GitHub仓库](https://github.com/TickPoints/algorithm_learning) 提交PR贡献内容.

常规修改:

• 小修改(<80行): 直接通过GitHub编辑功能提交
• 大修改(≥80行): 建议先创建issue讨论

内容排版

• 基础规范: 参考已有文档的排版风格
• 详细标准: 参见导论匹配指南

特殊情形

禁止事项

以下操作需特别审批:

1. 新增文档
2. 添加图片资源
3. 修改src/not-found.md
4. 删除任何文件
5. 修改src/外的任何文件
6. 改动README.md文件

例外流程

如需进行上述操作, 必须:

1. 提前报备: 在PR描述中明确说明特殊修改内容
2. issue支持: 提供相关issue链接(可自建或引用他人issue)
3. 等待审核: 创建issue后需等待合理时间(建议≥24小时)再提交PR

注意事项

• 简单需求(如创建空白文档)可由维护者协助完成
• 争议性修改可能被拒绝, 请保持理性沟通
• 重大修改建议先讨论方案再实施, 避免资源浪费