Rustc 开发指南工作组 - 简介

2019年10月28日 · Amanjeev Sethi 代表 rustc 开发指南工作组

Rustc 开发指南工作组成立于 2019 年 4 月,专注于通过确保 rustc-dev-guide 和 API 文档“完整”来使编译器更容易学习。这是 Rust 编译器团队为降低对编译器做出贡献的门槛而进行的众多努力之一。正如该工作组主页上指出的那样 —

该工作组旨在完成以下目标

  • 确保 rustc 的主要组件在 rustc-dev-guide 中得到覆盖
  • 确保 API 文档覆盖率至少达到 90%

学习小组正在通过改进针对新的和潜在贡献者的编译器文档来使贡献变得更容易。我们都知道这种偏见 - 我们在一个系统中花费的时间越多,我们就越不可能看到新手可能面临的问题。鉴于此,这个小组自然而然地成为了初学者的一个有吸引力的地方,他们可以从记录编译器内部结构中受益,同时也能学习这些部分。这通过为文档提供来自新贡献者的视角来使整个编译器团队受益。

一般来说,学习小组开始记录“编译器讲座系列”,这是一系列由编译器团队中更有经验的成员之前给出的 YouTube 视频讲座。还有改进 rustc-dev-guide 文档结构的任务。起初,每个成员都会自己选择一个视频讲座,并通过 Github pull request 贡献给 rustc-dev-guide Github 存储库。事实证明,由于以下原因,这有点困难 —

  1. 并非所有成员都能观看并研究他们选择的讲座。
  2. 知识仍然会根据谁观看了哪个讲座而分散。
  3. 有些讲座比其他讲座更有趣,这意味着一些贡献者会错过有趣的讲座。
  4. 某些讲座更难,需要多个人的投入。

因此,目前,小组决定一次处理一个视频。事实证明,这对整个小组都有好处,特别是讲座 在 rustc 中表示类型。在撰写本文时,它仍在进行中,但每个人的投入使得人们可以一起工作,同时受益于每个人对讲座的疑问。

该小组仍在学习组织和管理最佳方法,一些编译器团队的资深人士始终在那里提供帮助!我们始终需要现有编译器贡献者和希望做出贡献和学习的新人的帮助。

参与号召

加入该小组没有任何门槛。要加入该小组,您可以在 Zulip 上的 #t-compiler/wg-rustc-dev-guide 中留言介绍自己。我们很乐意收到您的来信,并希望我们共同努力可以使文档变得更好。

重要资源