@@ -10,25 +10,26 @@ You may also find the rustdocs [for the compiler itself][rustdocs] useful.
10
10
[ rustdocs ] : https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
11
11
12
12
The guide can be useful today, but it has a lot of work still go.
13
- Once it gets more complete, the plan is probably to move it into the
14
- [ main Rust repository] ( https://github.com/rust-lang/rust/ ) .
15
13
16
14
### Contributing to the guide
17
15
18
- If you'd like to help finish the guide, we'd love to have you! The
19
- main tracking issue for the guide
20
- [ can be found here] ( https://github.com/rust-lang-nursery/rustc-guide/issues/6 ) . From
21
- there, you can find a list of all the planned chapters and subsections.
22
- If you think something is missing, please open an issue about it!
23
- Otherwise, find a chapter that sounds interesting to you and then go
24
- to its associated issue. There should be a list of things to do.
16
+ If you'd like to help improve the guide, we'd love to have you! You can find
17
+ plenty of issues on the [ issue
18
+ tracker] ( https://github.com/rust-lang-nursery/rustc-guide/issue ) . Just post a
19
+ comment on the issue you would like to work on to make sure that we don't
20
+ accidentally duplicate work. If you think something is missing, please open an
21
+ issue about it!
25
22
26
23
** In general, if you don't know how the compiler works, that is not a
27
24
problem!** In that case, what we will do is to schedule a bit of time
28
25
for you to talk with someone who ** does** know the code, or who wants
29
26
to pair with you and figure it out. Then you can work on writing up
30
27
what you learned.
31
28
29
+ In general, when writing about a particular part of the compiler's code, we
30
+ recommend that you link to the relevant parts of the [ rustc
31
+ rustdocs] [ rustdocs ] .
32
+
32
33
To help prevent accidentally introducing broken links, we use the
33
34
` mdbook-linkcheck ` . If installed on your machine ` mdbook ` will automatically
34
35
invoke this link checker, otherwise it will emit a warning saying it couldn't
0 commit comments