Skip to content

Commit ac2777c

Browse files
committed
Feature (new inside-rust post): adds intro to learning wg post
1 parent 0c68f94 commit ac2777c

File tree

1 file changed

+82
-0
lines changed

1 file changed

+82
-0
lines changed
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
layout: post
3+
title: "The Rustc Learning Working Group - An Introduction"
4+
author: Amanjeev Sethi
5+
description: "introduction learning working group useful links"
6+
team: the compiler team <https://www.rust-lang.org/governance/teams/compiler>
7+
---
8+
9+
The [Learning Working Group], formed in April 2019, is focused on making the
10+
compiler easier to learn by ensuring that [rustc-guide] and API docs are
11+
"complete". It is one of the many efforts by the Rust Compiler team to
12+
decrease the barrier of contributing to the compiler. As noted on the WG’s
13+
homepage —
14+
15+
*This working group aims to accomplish the following:*
16+
17+
- *Ensure that major components of rustc are covered in rustc-guide*
18+
- *Ensure that API doc coverage is at least 90%*
19+
20+
The Learning Group is making entry to contribute easier by improving the
21+
compiler documentation for the new and potential contributors. We all know
22+
this bias — the more time we’ve spent in a system, the less likely we are to
23+
see the issues that the newcomers might face. Given that, this group
24+
organically became an attractive place for beginners, who would benefit
25+
from documenting the compiler internals, while learning those parts of it
26+
at the same time. This benefits the entire compiler team by giving the
27+
documentation a perspective from the new contributors.
28+
29+
The Learning group, in general, is starting to document the
30+
“Compiler lecture series”, which are a list of Youtube video lectures
31+
given earlier by the more knowledgeable members of the compiler team.
32+
There is also the task of improving the documentation structure of
33+
[rustc-guide]. At first, each member used to pick a video lecture by
34+
themselves and contribute via a Github pull request to the
35+
[rustc-guide Github repository]. This proved to be a bit difficult
36+
for the following reasons —
37+
38+
1. Not all members would get to watch and work on the lectures of
39+
their choice.
40+
2. The knowledge would still be fragmented depending on who watched
41+
which lecture.
42+
3. Some lectures are more interesting than others and this means that
43+
some contributors would miss out on the interesting ones.
44+
4. Certain lectures are more difficult and require input from multiple
45+
people.
46+
47+
Hence, at the moment, the group decided to work on one video at a time.
48+
This has proven to be beneficial for the entire group, especially with
49+
the lecture [Representing types in rustc]. At the time of this writing,
50+
it is still a work-in-progress but the input from everyone allows people
51+
to work together while benefiting from the questions that everyone has
52+
about the lecture.
53+
54+
The group is still learning about the best possible ways to organize and
55+
manage and some compiler team veterans are always there to help out!
56+
We are always in need of help from both existing compiler contributors
57+
and new folks who want to contribute and learn.
58+
59+
There is no bar to entry. Hope you will reach out and help improve
60+
the documentation.
61+
62+
## Important resources
63+
64+
- **[Learning Working Group]**
65+
- **[Rustc Guide Book]**
66+
- **[Rustc Guide Repository]**
67+
- **[Github Project (Kanban)]**
68+
- **[Learning WG Meeting Minutes]**
69+
- **[Rust Youtube Videos]**
70+
- **[Zulip Stream: `#t-compiler/wg-learning` on Zulip]**
71+
72+
[Learning Working Group]: https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/learning
73+
[rustc-guide]: https://rust-lang.github.io/rustc-guide/
74+
[Rustc Guide Book]: https://rust-lang.github.io/rustc-guide/
75+
[rustc-guide Github repository]: https://github.com/rust-lang/rustc-guide
76+
[Rustc Guide Repository]: https://github.com/rust-lang/rustc-guide
77+
[Representing types in rustc]: https://www.youtube.com/watch?v=c01TsOsr3-c
78+
[Github Project (Kanban)]: https://github.com/rust-lang/rustc-guide/projects/2
79+
[Learning WG Meeting Minutes]: https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/learning/minutes
80+
[Rust Youtube Videos]: https://www.youtube.com/channel/UCaYhcUwRBNscFNUKTjgPFiA/playlists
81+
[rust-lang/rust]: https://github.com/rust-lang/rust
82+
[Zulip Stream: `#t-compiler/wg-learning` on Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning

0 commit comments

Comments
 (0)