仓库组织结构

相关源文件

• README.md

目的与范围

本文档解释了 Build Your Own X 仓库的结构和组织方式。它涵盖了教程按技术类型和编程语言的分类、仓库布局及其组织原则。该仓库是一个精选资源集合，旨在指导开发人员从零开始构建技术，其组织结构旨在促进发现和学习。

有关向仓库贡献新教程的信息，请参阅如何贡献。

来源：README.md3-9

高层结构

Build Your Own X 仓库遵循一种简单而有效的组织结构。该仓库主要包含一个全面的 README.md 文件，作为所有教程的索引。

存储库结构图:

来源：README.md1-9 README.md475-483

按技术分类

该仓库将教程分为不同的技术类别，创建了逻辑分组，帮助用户根据兴趣查找资源。每个类别代表可以从零开始构建的特定系统或应用程序类型。

技术类别图:

来源：README.md11-37

该仓库包含 25 个以上主要技术类别，每个类别下有多个教程。这些类别涵盖从操作系统等底层基础设施组件到游戏和文本编辑器等高级应用程序。

类别内的教程结构

README 中每个技术类别部分都遵循一致的模式，以便于按编程语言查找教程。

教程条目结构:

组件	描述	示例
语言指示符	加粗的编程语言	Python
教程标题	斜体标题	通过构建学习区块链
资源链接	教程网址	https://hackernoon.com/...
格式指示符	可选的 [video] 标签	[video]

每个教程条目都遵循此格式

* <FileRef file-url="https://github.com/codecrafters-io/build-your-own-x/blob/cf5d7501/**Language**#LNaN-LNaN" NaN  file-path="**Language**">Hii</FileRef>

类别示例结构:

来源：README.md129-142

编程语言分布

教程提供多种编程语言版本，以适应不同的偏好和学习目标。这种跨语言方法使用户能够以自己喜欢的语言学习相同的概念，或探索不同语言如何处理类似问题。

编程语言覆盖:

来源：README.md41-473

C、C++、Python、JavaScript 和 Rust 等主流编程语言在不同技术类别中拥有最广泛的覆盖，而专业语言则倾向于在其优势领域提供教程。

组织原则

该仓库在组织上遵循以下几个关键原则：

1. 按系统类型分类：主要按所构建的技术类型进行组织
2. 语言多样性：每种系统类型都有多种语言实现
3. 渐进复杂性：从简单项目到复杂项目的自然演进
4. 文档质量：注重文档完善、分步指导的教程
5. 从零开始构建：强调从基本原理构建系统

这种组织结构有助于实现不同的学习路径：

• 以技术为中心的学习（学习特定系统）
• 以语言为中心的学习（掌握特定编程语言）
• 适合技能水平的路径（从初级到高级）

来源：README.md3-9 README.md475-483

贡献结构

该仓库欢迎通过拉取请求或创建问题进行贡献。提交的内容在合并到主仓库之前会经过维护者和贡献者的审查。

来源：README.md475-477

该仓库由 CodeCrafters, Inc. 维护，但欢迎符合其宗旨的社区贡献，即提供高质量的、用于从零开始构建技术的教育资源。