-
Notifications
You must be signed in to change notification settings - Fork 303
New inside-rust blog post -- The Rustc Learning Working Group - An Introduction #438
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
nikomatsakis
merged 5 commits into
rust-lang:master
from
amanjeev:amanjeev/rustc-learning-wg-intro
Oct 28, 2019
+87
−0
Merged
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ac2777c
Feature (new inside-rust post): adds intro to learning wg post
amanjeev b3b5ca6
Feature (new inside-rust post): adds call for participation section
amanjeev b03a447
Feature (new inside-rust post): improvement suggestions from PR
amanjeev 0e5c403
Feature (new inside-rust post): change 'on behalf of' name to the lea…
amanjeev fde10ee
Update and rename 2019-10-26-rustc-learning-working-group-introductio…
nikomatsakis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
88 changes: 88 additions & 0 deletions
88
posts/inside-rust/2019-10-26-rustc-learning-working-group-introduction.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
--- | ||
layout: post | ||
title: "The Rustc Learning Working Group - An Introduction" | ||
author: Amanjeev Sethi | ||
description: "introduction learning working group useful links" | ||
team: the compiler team <https://www.rust-lang.org/governance/teams/compiler> | ||
--- | ||
|
||
The [Learning Working Group], formed in April 2019, is focused on making the | ||
compiler easier to learn by ensuring that [rustc-guide] and API docs are | ||
"complete". It is one of the many efforts by the Rust Compiler team to | ||
decrease the barrier of contributing to the compiler. As noted on the WG’s | ||
homepage — | ||
|
||
*This working group aims to accomplish the following:* | ||
|
||
- *Ensure that major components of rustc are covered in rustc-guide* | ||
- *Ensure that API doc coverage is at least 90%* | ||
|
||
The Learning Group is making entry to contribute easier by improving the | ||
compiler documentation for the new and potential contributors. We all know | ||
this bias — the more time we’ve spent in a system, the less likely we are to | ||
see the issues that the newcomers might face. Given that, this group | ||
organically became an attractive place for beginners, who would benefit | ||
from documenting the compiler internals, while learning those parts of it | ||
at the same time. This benefits the entire compiler team by giving the | ||
documentation a perspective from the new contributors. | ||
|
||
The Learning group, in general, is starting to document the | ||
“Compiler lecture series”, which are a list of Youtube video lectures | ||
given earlier by the more knowledgeable members of the compiler team. | ||
There is also the task of improving the documentation structure of | ||
[rustc-guide]. At first, each member used to pick a video lecture by | ||
themselves and contribute via a Github pull request to the | ||
[rustc-guide Github repository]. This proved to be a bit difficult | ||
for the following reasons — | ||
|
||
1. Not all members would get to watch and work on the lectures of | ||
their choice. | ||
2. The knowledge would still be fragmented depending on who watched | ||
which lecture. | ||
3. Some lectures are more interesting than others and this means that | ||
some contributors would miss out on the interesting ones. | ||
4. Certain lectures are more difficult and require input from multiple | ||
people. | ||
|
||
Hence, at the moment, the group decided to work on one video at a time. | ||
This has proven to be beneficial for the entire group, especially with | ||
the lecture [Representing types in rustc]. At the time of this writing, | ||
it is still a work-in-progress but the input from everyone allows people | ||
to work together while benefiting from the questions that everyone has | ||
about the lecture. | ||
|
||
The group is still learning about the best possible ways to organize and | ||
manage and some compiler team veterans are always there to help out! | ||
We are always in need of help from both existing compiler contributors | ||
and new folks who want to contribute and learn. | ||
|
||
## Call for participation | ||
|
||
There is no bar to entry in the group. To join the group, you can | ||
drop a message in [`#t-compiler/wg-learning` on Zulip] introducing | ||
yourself and maybe if you have ideas on improvements to rustc-guide. | ||
We would love to hear from you. Hope you will reach out and help improve | ||
the documentation. | ||
amanjeev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Important resources | ||
|
||
- **[Learning Working Group]** | ||
- **[Rustc Guide Book]** | ||
- **[Rustc Guide Repository]** | ||
- **[Github Project (Kanban)]** | ||
- **[Learning WG Meeting Minutes]** | ||
- **[Rust Youtube Videos]** | ||
- **[Zulip Stream: `#t-compiler/wg-learning` on Zulip]** | ||
|
||
[Learning Working Group]: https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/learning | ||
[rustc-guide]: https://rust-lang.github.io/rustc-guide/ | ||
[Rustc Guide Book]: https://rust-lang.github.io/rustc-guide/ | ||
[rustc-guide Github repository]: https://github.com/rust-lang/rustc-guide | ||
[Rustc Guide Repository]: https://github.com/rust-lang/rustc-guide | ||
[Representing types in rustc]: https://www.youtube.com/watch?v=c01TsOsr3-c | ||
[Github Project (Kanban)]: https://github.com/rust-lang/rustc-guide/projects/2 | ||
[Learning WG Meeting Minutes]: https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/learning/minutes | ||
[Rust Youtube Videos]: https://www.youtube.com/channel/UCaYhcUwRBNscFNUKTjgPFiA/playlists | ||
[rust-lang/rust]: https://github.com/rust-lang/rust | ||
[Zulip Stream: `#t-compiler/wg-learning` on Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning | ||
[`#t-compiler/wg-learning` on Zulip]: https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.