于 2019 年 4 月成立的Rustc Dev Guide 工作组,致力于通过确保 rustc-dev-guide 和 API 文档“完整”,让编译器更容易学习。这是 Rust 编译器团队为降低对编译器贡献的门槛而付出的众多努力之一。正如该工作组主页上所述——
该工作组旨在实现以下目标
- 确保 rustc 的主要组件在 rustc-dev-guide 中得到覆盖
- 确保 API 文档覆盖率至少达到 90%
学习小组通过改进针对新的和潜在贡献者的编译器文档,使贡献更容易入门。我们都知道这种偏见——在一个系统中花费的时间越多,就越不可能看到新手可能面临的问题。考虑到这一点,该小组自然而然地成为了一个吸引初学者的场所,他们可以通过记录编译器内部结构而受益,同时也在学习这些部分。这通过为文档提供新贡献者的视角,使整个编译器团队受益。
学习小组总体上正在开始记录“编译器讲座系列”,这是一系列由编译器团队知识渊博的成员早期提供的 Youtube 视频讲座。还有一个任务是改进 rustc-dev-guide 的文档结构。起初,每个成员会自己挑选一个视频讲座,并通过 Github pull request 向 rustc-dev-guide Github 仓库贡献。这由于以下原因而有些困难——
- 并非所有成员都能观看和研究他们选择的讲座。
- 知识仍然会因谁观看了哪个讲座而分散。
- 有些讲座比其他讲座更有趣,这意味着一些贡献者会错过有趣的讲座。
- 某些讲座更困难,需要多人输入。
因此,目前该小组决定一次处理一个视频。这已被证明对整个小组有利,特别是对于关于 Representing types in rustc 的讲座。撰写本文时,它仍在进行中,但每个人的输入使人们能够一起工作,同时从每个人关于讲座的问题中受益。
该小组仍在学习最佳的组织和管理方式,并且总有一些编译器团队的资深成员在提供帮助!我们总是需要现有编译器贡献者以及希望贡献和学习的新成员的帮助。
招募参与者
加入该小组没有门槛。要加入,您可以在 #t-compiler/wg-rustc-dev-guide
on Zulip 中留言介绍自己。我们很高兴听到您的声音,并希望我们大家一起能让文档变得更好。