]> git.lizzy.rs Git - rust.git/blob - CONTRIBUTING.md
Rollup merge of #49906 - kennytm:stable-unreachable, r=sfackler
[rust.git] / CONTRIBUTING.md
1 # Contributing to Rust
2 [contributing-to-rust]: #contributing-to-rust
3
4 Thank you for your interest in contributing to Rust! There are many ways to
5 contribute, and we appreciate all of them. This document is a bit long, so here's
6 links to the major sections:
7
8 * [Feature Requests](#feature-requests)
9 * [Bug Reports](#bug-reports)
10 * [The Build System](#the-build-system)
11 * [Pull Requests](#pull-requests)
12 * [Writing Documentation](#writing-documentation)
13 * [Issue Triage](#issue-triage)
14 * [Out-of-tree Contributions](#out-of-tree-contributions)
15 * [Helpful Links and Information](#helpful-links-and-information)
16
17 If you have questions, please make a post on [internals.rust-lang.org][internals] or
18 hop on [#rust-internals][pound-rust-internals].
19
20 As a reminder, all contributors are expected to follow our [Code of Conduct][coc].
21
22 [pound-rust-internals]: https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals
23 [internals]: https://internals.rust-lang.org
24 [coc]: https://www.rust-lang.org/conduct.html
25
26 ## Feature Requests
27 [feature-requests]: #feature-requests
28
29 To request a change to the way the Rust language works, please head over
30 to the [RFCs repository](https://github.com/rust-lang/rfcs) and view the 
31 [README](https://github.com/rust-lang/rfcs/blob/master/README.md)
32 for instructions.
33
34 ## Bug Reports
35 [bug-reports]: #bug-reports
36
37 While bugs are unfortunate, they're a reality in software. We can't fix what we
38 don't know about, so please report liberally. If you're not sure if something
39 is a bug or not, feel free to file a bug anyway.
40
41 **If you believe reporting your bug publicly represents a security risk to Rust users,
42 please follow our [instructions for reporting security vulnerabilities](https://www.rust-lang.org/security.html)**.
43
44 If you have the chance, before reporting a bug, please [search existing
45 issues](https://github.com/rust-lang/rust/search?q=&type=Issues&utf8=%E2%9C%93),
46 as it's possible that someone else has already reported your error. This doesn't
47 always work, and sometimes it's hard to know what to search for, so consider this
48 extra credit. We won't mind if you accidentally file a duplicate report.
49
50 Opening an issue is as easy as following [this
51 link](https://github.com/rust-lang/rust/issues/new) and filling out the fields.
52 Here's a template that you can use to file a bug, though it's not necessary to
53 use it exactly:
54
55     <short summary of the bug>
56
57     I tried this code:
58
59     <code sample that causes the bug>
60
61     I expected to see this happen: <explanation>
62
63     Instead, this happened: <explanation>
64
65     ## Meta
66
67     `rustc --version --verbose`:
68
69     Backtrace:
70
71 All three components are important: what you did, what you expected, what
72 happened instead. Please include the output of `rustc --version --verbose`,
73 which includes important information about what platform you're on, what
74 version of Rust you're using, etc.
75
76 Sometimes, a backtrace is helpful, and so including that is nice. To get
77 a backtrace, set the `RUST_BACKTRACE` environment variable to a value
78 other than `0`. The easiest way
79 to do this is to invoke `rustc` like this:
80
81 ```bash
82 $ RUST_BACKTRACE=1 rustc ...
83 ```
84
85 ## The Build System
86 [the-build-system]: #the-build-system
87
88 Rust's build system allows you to bootstrap the compiler, run tests &
89 benchmarks, generate documentation, install a fresh build of Rust, and more.
90 It's your best friend when working on Rust, allowing you to compile & test
91 your contributions before submission.
92
93 The build system lives in [the `src/bootstrap` directory][bootstrap] in the
94 project root. Our build system is itself written in Rust and is based on Cargo
95 to actually build all the compiler's crates. If you have questions on the build
96 system internals, try asking in [`#rust-internals`][pound-rust-internals].
97
98 [bootstrap]: https://github.com/rust-lang/rust/tree/master/src/bootstrap/
99
100 ### Configuration
101 [configuration]: #configuration
102
103 Before you can start building the compiler you need to configure the build for
104 your system. In most cases, that will just mean using the defaults provided
105 for Rust.
106
107 To change configuration, you must copy the file `config.toml.example`
108 to `config.toml` in the directory from which you will be running the build, and
109 change the settings provided.
110
111 There are large number of options provided in this config file that will alter the
112 configuration used in the build process. Some options to note:
113
114 #### `[llvm]`:
115 - `assertions = true` = This enables LLVM assertions, which makes LLVM misuse cause an assertion failure instead of weird misbehavior. This also slows down the compiler's runtime by ~20%.
116 - `ccache = true` - Use ccache when building llvm
117
118 #### `[build]`:
119 - `compiler-docs = true` - Build compiler documentation
120
121 #### `[rust]`:
122 - `debuginfo = true` - Build a compiler with debuginfo. Makes building rustc slower, but then you can use a debugger to debug `rustc`.
123 - `debuginfo-lines = true` - An alternative to `debuginfo = true` that doesn't let you use a debugger, but doesn't make building rustc slower and still gives you line numbers in backtraces.
124 - `debuginfo-tools = true` - Build the extended tools with debuginfo.
125 - `debug-assertions = true` - Makes the log output of `debug!` work.
126 - `optimize = false` - Disable optimizations to speed up compilation of stage1 rust, but makes the stage1 compiler x100 slower.
127
128 For more options, the `config.toml` file contains commented out defaults, with
129 descriptions of what each option will do.
130
131 Note: Previously the `./configure` script was used to configure this
132 project. It can still be used, but it's recommended to use a `config.toml`
133 file. If you still have a `config.mk` file in your directory - from
134 `./configure` - you may need to delete it for `config.toml` to work.
135
136 ### Building
137 [building]: #building
138
139 A default configuration shall use around 3.5 GB of disk space, whereas building a debug configuration may require more than 30 GB.
140
141 Dependencies
142 - [build dependencies](README.md#building-from-source)
143 - `gdb` 6.2.0 minimum, 7.1 or later recommended for test builds
144
145 The build system uses the `x.py` script to control the build process. This script
146 is used to build, test, and document various parts of the compiler. You can
147 execute it as:
148
149 ```sh
150 python x.py build
151 ```
152
153 On some systems you can also use the shorter version:
154
155 ```sh
156 ./x.py build
157 ```
158
159 To learn more about the driver and top-level targets, you can execute:
160
161 ```sh
162 python x.py --help
163 ```
164
165 The general format for the driver script is:
166
167 ```sh
168 python x.py <command> [<directory>]
169 ```
170
171 Some example commands are `build`, `test`, and `doc`. These will build, test,
172 and document the specified directory. The second argument, `<directory>`, is
173 optional and defaults to working over the entire compiler. If specified,
174 however, only that specific directory will be built. For example:
175
176 ```sh
177 # build the entire compiler
178 python x.py build
179
180 # build all documentation
181 python x.py doc
182
183 # run all test suites
184 python x.py test
185
186 # build only the standard library
187 python x.py build src/libstd
188
189 # test only one particular test suite
190 python x.py test src/test/rustdoc
191
192 # build only the stage0 libcore library
193 python x.py build src/libcore --stage 0
194 ```
195
196 You can explore the build system through the various `--help` pages for each
197 subcommand. For example to learn more about a command you can run:
198
199 ```
200 python x.py build --help
201 ```
202
203 To learn about all possible rules you can execute, run:
204
205 ```
206 python x.py build --help --verbose
207 ```
208
209 Note: Previously `./configure` and `make` were used to build this project.
210 They are still available, but `x.py` is the recommended build system.
211
212 ### Useful commands
213 [useful-commands]: #useful-commands
214
215 Some common invocations of `x.py` are:
216
217 - `x.py build --help` - show the help message and explain the subcommand
218 - `x.py build src/libtest --stage 1` - build up to (and including) the first
219   stage. For most cases we don't need to build the stage2 compiler, so we can
220   save time by not building it. The stage1 compiler is a fully functioning
221   compiler and (probably) will be enough to determine if your change works as
222   expected.
223 - `x.py build src/rustc --stage 1` - This will build just rustc, without libstd.
224   This is the fastest way to recompile after you changed only rustc source code.
225   Note however that the resulting rustc binary won't have a stdlib to link
226   against by default. You can build libstd once with `x.py build src/libstd`,
227   but it is only guaranteed to work if recompiled, so if there are any issues
228   recompile it.
229 - `x.py test` - build the full compiler & run all tests (takes a while). This
230   is what gets run by the continuous integration system against your pull
231   request. You should run this before submitting to make sure your tests pass
232   & everything builds in the correct manner.
233 - `x.py test src/libstd --stage 1` - test the standard library without
234   recompiling stage 2.
235 - `x.py test src/test/run-pass --test-args TESTNAME` - Run a matching set of
236   tests.
237   - `TESTNAME` should be a substring of the tests to match against e.g. it could
238     be the fully qualified test name, or just a part of it.
239     `TESTNAME=collections::hash::map::test_map::test_capacity_not_less_than_len`
240     or `TESTNAME=test_capacity_not_less_than_len`.
241 - `x.py test src/test/run-pass --stage 1 --test-args <substring-of-test-name>` -
242   Run a single rpass test with the stage1 compiler (this will be quicker than
243   running the command above as we only build the stage1 compiler, not the entire
244   thing).  You can also leave off the directory argument to run all stage1 test
245   types.
246 - `x.py test src/libcore --stage 1` - Run stage1 tests in `libcore`.
247 - `x.py test src/tools/tidy` - Check that the source code is in compliance with
248   Rust's style guidelines. There is no official document describing Rust's full
249   guidelines as of yet, but basic rules like 4 spaces for indentation and no
250   more than 99 characters in a single line should be kept in mind when writing
251   code.
252
253 ### Using your local build
254 [using-local-build]: #using-local-build
255
256 If you use Rustup to manage your rust install, it has a feature called ["custom
257 toolchains"][toolchain-link] that you can use to access your newly-built compiler
258 without having to install it to your system or user PATH. If you've run `python
259 x.py build`, then you can add your custom rustc to a new toolchain like this:
260
261 [toolchain-link]: https://github.com/rust-lang-nursery/rustup.rs#working-with-custom-toolchains-and-local-builds
262
263 ```
264 rustup toolchain link <name> build/<host-triple>/stage2
265 ```
266
267 Where `<host-triple>` is the build triple for the host (the triple of your
268 computer, by default), and `<name>` is the name for your custom toolchain. (If you
269 added `--stage 1` to your build command, the compiler will be in the `stage1`
270 folder instead.) You'll only need to do this once - it will automatically point
271 to the latest build you've done.
272
273 Once this is set up, you can use your custom toolchain just like any other. For
274 example, if you've named your toolchain `local`, running `cargo +local build` will
275 compile a project with your custom rustc, setting `rustup override set local` will
276 override the toolchain for your current directory, and `cargo +local doc` will use
277 your custom rustc and rustdoc to generate docs. (If you do this with a `--stage 1`
278 build, you'll need to build rustdoc specially, since it's not normally built in
279 stage 1. `python x.py build --stage 1 src/libstd src/tools/rustdoc` will build
280 rustdoc and libstd, which will allow rustdoc to be run with that toolchain.)
281
282 ### Out-of-tree builds
283 [out-of-tree-builds]: #out-of-tree-builds
284
285 Rust's `x.py` script fully supports out-of-tree builds - it looks for
286 the Rust source code from the directory `x.py` was found in, but it
287 reads the `config.toml` configuration file from the directory it's
288 run in, and places all build artifacts within a subdirectory named `build`.
289
290 This means that if you want to do an out-of-tree build, you can just do it:
291 ```
292 $ cd my/build/dir
293 $ cp ~/my-config.toml config.toml # Or fill in config.toml otherwise
294 $ path/to/rust/x.py build
295 ...
296 $ # This will use the Rust source code in `path/to/rust`, but build
297 $ # artifacts will now be in ./build
298 ```
299
300 It's absolutely fine to have multiple build directories with different
301 `config.toml` configurations using the same code.
302
303 ## Pull Requests
304 [pull-requests]: #pull-requests
305
306 Pull requests are the primary mechanism we use to change Rust. GitHub itself
307 has some [great documentation][about-pull-requests] on using the Pull Request feature.
308 We use the "fork and pull" model [described here][development-models], where
309 contributors push changes to their personal fork and create pull requests to
310 bring those changes into the source repository.
311
312 [about-pull-requests]: https://help.github.com/articles/about-pull-requests/
313 [development-models]: https://help.github.com/articles/about-collaborative-development-models/
314
315 Please make pull requests against the `master` branch.
316
317 Compiling all of `./x.py test` can take a while. When testing your pull request,
318 consider using one of the more specialized `./x.py` targets to cut down on the
319 amount of time you have to wait. You need to have built the compiler at least
320 once before running these will work, but that’s only one full build rather than
321 one each time.
322
323     $ python x.py test --stage 1
324
325 is one such example, which builds just `rustc`, and then runs the tests. If
326 you’re adding something to the standard library, try
327
328     $ python x.py test src/libstd --stage 1
329
330 Please make sure your pull request is in compliance with Rust's style
331 guidelines by running
332
333     $ python x.py test src/tools/tidy
334
335 Make this check before every pull request (and every new commit in a pull
336 request) ; you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
337 before every push to make sure you never forget to make this check.
338
339 All pull requests are reviewed by another person. We have a bot,
340 @rust-highfive, that will automatically assign a random person to review your
341 request.
342
343 If you want to request that a specific person reviews your pull request,
344 you can add an `r?` to the message. For example, Steve usually reviews
345 documentation changes. So if you were to make a documentation change, add
346
347     r? @steveklabnik
348
349 to the end of the message, and @rust-highfive will assign @steveklabnik instead
350 of a random person. This is entirely optional.
351
352 After someone has reviewed your pull request, they will leave an annotation
353 on the pull request with an `r+`. It will look something like this:
354
355     @bors: r+ 38fe8d2
356
357 This tells @bors, our lovable integration bot, that your pull request has
358 been approved. The PR then enters the [merge queue][merge-queue], where @bors
359 will run all the tests on every platform we support. If it all works out,
360 @bors will merge your code into `master` and close the pull request.
361
362 [merge-queue]: https://buildbot2.rust-lang.org/homu/queue/rust
363
364 Speaking of tests, Rust has a comprehensive test suite. More information about
365 it can be found
366 [here](https://github.com/rust-lang/rust/blob/master/src/test/COMPILER_TESTS.md).
367
368 ### External Dependencies
369 [external-dependencies]: #external-dependencies
370
371 Currently building Rust will also build the following external projects:
372
373 * [clippy](https://github.com/rust-lang-nursery/rust-clippy)
374 * [miri](https://github.com/solson/miri)
375 * [rustfmt](https://github.com/rust-lang-nursery/rustfmt)
376 * [rls](https://github.com/rust-lang-nursery/rls/)
377
378 We allow breakage of these tools in the nightly channel. Maintainers of these
379 projects will be notified of the breakages and should fix them as soon as
380 possible.
381
382 After the external is fixed, one could add the changes with
383
384 ```sh
385 git add path/to/submodule
386 ```
387
388 outside the submodule.
389
390 In order to prepare your tool-fixing PR, you can run the build locally by doing
391 `./x.py build src/tools/TOOL`. If you will be editing the sources
392 there, you may wish to set `submodules = false` in the `config.toml`
393 to prevent `x.py` from resetting to the original branch.
394
395 Breakage is not allowed in the beta and stable channels, and must be addressed
396 before the PR is merged.
397
398 #### Breaking Tools Built With The Compiler
399 [breaking-tools-built-with-the-compiler]: #breaking-tools-built-with-the-compiler
400
401 Rust's build system builds a number of tools that make use of the
402 internals of the compiler. This includes clippy,
403 [RLS](https://github.com/rust-lang-nursery/rls) and
404 [rustfmt](https://github.com/rust-lang-nursery/rustfmt). If these tools
405 break because of your changes, you may run into a sort of "chicken and egg"
406 problem. These tools rely on the latest compiler to be built so you can't update
407 them to reflect your changes to the compiler until those changes are merged into
408 the compiler. At the same time, you can't get your changes merged into the compiler
409 because the rust-lang/rust build won't pass until those tools build and pass their
410 tests.
411
412 That means that, in the default state, you can't update the compiler without first
413 fixing rustfmt, rls and the other tools that the compiler builds.
414
415 Luckily, a feature was [added to Rust's build](https://github.com/rust-lang/rust/issues/45861)
416 to make all of this easy to handle. The idea is that we allow these tools to be "broken",
417 so that the rust-lang/rust build passes without trying to build them, then land the change
418 in the compiler, wait for a nightly, and go update the tools that you broke. Once you're done
419 and the tools are working again, you go back in the compiler and update the tools
420 so they can be distributed again.
421
422 This should avoid a bunch of synchronization dances and is also much easier on contributors as
423 there's no need to block on rls/rustfmt/other tools changes going upstream.
424
425 Here are those same steps in detail:
426
427 1. (optional) First, if it doesn't exist already, create a `config.toml` by copying
428    `config.toml.example` in the root directory of the Rust repository.
429    Set `submodules = false` in the `[build]` section. This will prevent `x.py`
430    from resetting to the original branch after you make your changes. If you
431    need to [update any submodules to their latest versions][updating-submodules],
432    see the section of this file about that for more information.
433 2. (optional) Run `./x.py test src/tools/rustfmt` (substituting the submodule
434    that broke for `rustfmt`). Fix any errors in the submodule (and possibly others).
435 3. (optional) Make commits for your changes and send them to upstream repositories as a PR.
436 4. (optional) Maintainers of these submodules will **not** merge the PR. The PR can't be
437    merged because CI will be broken. You'll want to write a message on the PR referencing
438    your change, and how the PR should be merged once your change makes it into a nightly.
439 5. Wait for your PR to merge.
440 6. Wait for a nightly
441 7. (optional) Help land your PR on the upstream repository now that your changes are in nightly.
442 8. (optional) Send a PR to rust-lang/rust updating the submodule.
443
444 #### Updating submodules
445 [updating-submodules]: #updating-submodules
446
447 These instructions are specific to updating `rustfmt`, however they may apply
448 to the other submodules as well. Please help by improving these instructions
449 if you find any discrepancies or special cases that need to be addressed.
450
451 To update the `rustfmt` submodule, start by running the appropriate
452 [`git submodule` command](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
453 For example, to update to the latest commit on the remote master branch,
454 you may want to run:
455 ```
456 git submodule update --remote src/tools/rustfmt
457 ```
458 If you run `./x.py build` now, and you are lucky, it may just work. If you see
459 an error message about patches that did not resolve to any crates, you will need
460 to complete a few more steps which are outlined with their rationale below.
461
462 *(This error may change in the future to include more information.)*
463 ```
464 error: failed to resolve patches for `https://github.com/rust-lang-nursery/rustfmt`
465
466 Caused by:
467   patch for `rustfmt-nightly` in `https://github.com/rust-lang-nursery/rustfmt` did not resolve to any crates
468 failed to run: ~/rust/build/x86_64-unknown-linux-gnu/stage0/bin/cargo build --manifest-path ~/rust/src/bootstrap/Cargo.toml
469 ```
470
471 If you haven't used the `[patch]`
472 section of `Cargo.toml` before, there is [some relevant documentation about it
473 in the cargo docs](http://doc.crates.io/manifest.html#the-patch-section). In
474 addition to that, you should read the
475 [Overriding dependencies](http://doc.crates.io/specifying-dependencies.html#overriding-dependencies)
476 section of the documentation as well.
477
478 Specifically, the following [section in Overriding dependencies](http://doc.crates.io/specifying-dependencies.html#testing-a-bugfix) reveals what the problem is:
479
480 > Next up we need to ensure that our lock file is updated to use this new version of uuid so our project uses the locally checked out copy instead of one from crates.io. The way [patch] works is that it'll load the dependency at ../path/to/uuid and then whenever crates.io is queried for versions of uuid it'll also return the local version.
481 >
482 > This means that the version number of the local checkout is significant and will affect whether the patch is used. Our manifest declared uuid = "1.0" which means we'll only resolve to >= 1.0.0, < 2.0.0, and Cargo's greedy resolution algorithm also means that we'll resolve to the maximum version within that range. Typically this doesn't matter as the version of the git repository will already be greater or match the maximum version published on crates.io, but it's important to keep this in mind!
483
484 This says that when we updated the submodule, the version number in our
485 `src/tools/rustfmt/Cargo.toml` changed. The new version is different from
486 the version in `Cargo.lock`, so the build can no longer continue.
487
488 To resolve this, we need to update `Cargo.lock`. Luckily, cargo provides a
489 command to do this easily.
490
491 First, go into the `src/` directory since that is where `Cargo.toml` is in
492 the rust repository. Then run, `cargo update -p rustfmt-nightly` to solve
493 the problem.
494
495 ```
496 $ cd src
497 $ cargo update -p rustfmt-nightly
498 ```
499
500 This should change the version listed in `src/Cargo.lock` to the new version you updated
501 the submodule to. Running `./x.py build` should work now.
502
503 ## Writing Documentation
504 [writing-documentation]: #writing-documentation
505
506 Documentation improvements are very welcome. The source of `doc.rust-lang.org`
507 is located in `src/doc` in the tree, and standard API documentation is generated
508 from the source code itself.
509
510 Documentation pull requests function in the same way as other pull requests,
511 though you may see a slightly different form of `r+`:
512
513     @bors: r+ 38fe8d2 rollup
514
515 That additional `rollup` tells @bors that this change is eligible for a 'rollup'.
516 To save @bors some work, and to get small changes through more quickly, when
517 @bors attempts to merge a commit that's rollup-eligible, it will also merge
518 the other rollup-eligible patches too, and they'll get tested and merged at
519 the same time.
520
521 To find documentation-related issues, sort by the [T-doc label][tdoc].
522
523 [tdoc]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AT-doc
524
525 You can find documentation style guidelines in [RFC 1574][rfc1574].
526
527 [rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
528
529 In many cases, you don't need a full `./x.py doc`. You can use `rustdoc` directly
530 to check small fixes. For example, `rustdoc src/doc/reference.md` will render
531 reference to `doc/reference.html`. The CSS might be messed up, but you can
532 verify that the HTML is right.
533
534 ## Issue Triage
535 [issue-triage]: #issue-triage
536
537 Sometimes, an issue will stay open, even though the bug has been fixed. And
538 sometimes, the original bug may go stale because something has changed in the
539 meantime.
540
541 It can be helpful to go through older bug reports and make sure that they are
542 still valid. Load up an older issue, double check that it's still true, and
543 leave a comment letting us know if it is or is not. The [least recently
544 updated sort][lru] is good for finding issues like this.
545
546 Contributors with sufficient permissions on the Rust repo can help by adding
547 labels to triage issues:
548
549 * Yellow, **A**-prefixed labels state which **area** of the project an issue
550   relates to.
551
552 * Magenta, **B**-prefixed labels identify bugs which are **blockers**.
553
554 * Dark blue, **beta-** labels track changes which need to be backported into
555   the beta branches.
556
557 * Light purple, **C**-prefixed labels represent the **category** of an issue.
558
559 * Green, **E**-prefixed labels explain the level of **experience** necessary
560   to fix the issue.
561
562 * The dark blue **final-comment-period** label marks bugs that are using the
563   RFC signoff functionality of [rfcbot][rfcbot] and are currenty in the final
564   comment period.
565
566 * Red, **I**-prefixed labels indicate the **importance** of the issue. The
567   [I-nominated][inom] label indicates that an issue has been nominated for
568   prioritizing at the next triage meeting.
569
570 * The purple **metabug** label marks lists of bugs collected by other
571   categories.
572
573 * Purple gray, **O**-prefixed labels are the **operating system** or platform
574   that this issue is specific to.
575
576 * Orange, **P**-prefixed labels indicate a bug's **priority**. These labels
577   are only assigned during triage meetings, and replace the [I-nominated][inom]
578   label.
579
580 * The gray **proposed-final-comment-period** label marks bugs that are using
581   the RFC signoff functionality of [rfcbot][rfcbot] and are currently awaiting
582   signoff of all team members in order to enter the final comment period.
583
584 * Pink, **regression**-prefixed labels track regressions from stable to the
585   release channels.
586
587 * The light orange **relnotes** label marks issues that should be documented in
588   the release notes of the next release.
589
590 * Gray, **S**-prefixed labels are used for tracking the **status** of pull
591   requests.
592
593 * Blue, **T**-prefixed bugs denote which **team** the issue belongs to.
594
595 If you're looking for somewhere to start, check out the [E-easy][eeasy] tag.
596
597 [inom]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AI-nominated
598 [eeasy]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy
599 [lru]: https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc
600 [rfcbot]: https://github.com/anp/rfcbot-rs/
601
602 ## Out-of-tree Contributions
603 [out-of-tree-contributions]: #out-of-tree-contributions
604
605 There are a number of other ways to contribute to Rust that don't deal with
606 this repository.
607
608 Answer questions in [#rust][pound-rust], or on [users.rust-lang.org][users],
609 or on [StackOverflow][so].
610
611 Participate in the [RFC process](https://github.com/rust-lang/rfcs).
612
613 Find a [requested community library][community-library], build it, and publish
614 it to [Crates.io](http://crates.io). Easier said than done, but very, very
615 valuable!
616
617 [pound-rust]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust
618 [users]: https://users.rust-lang.org/
619 [so]: http://stackoverflow.com/questions/tagged/rust
620 [community-library]: https://github.com/rust-lang/rfcs/labels/A-community-library
621
622 ## Helpful Links and Information
623 [helpful-info]: #helpful-info
624
625 For people new to Rust, and just starting to contribute, or even for
626 more seasoned developers, some useful places to look for information
627 are:
628
629 * The [rustc guide] contains information about how various parts of the compiler work
630 * [Rust Forge][rustforge] contains additional documentation, including write-ups of how to achieve common tasks
631 * The [Rust Internals forum][rif], a place to ask questions and
632   discuss Rust's internals
633 * The [generated documentation for rust's compiler][gdfrustc]
634 * The [rust reference][rr], even though it doesn't specifically talk about Rust's internals, it's a great resource nonetheless
635 * Although out of date, [Tom Lee's great blog article][tlgba] is very helpful
636 * [rustaceans.org][ro] is helpful, but mostly dedicated to IRC
637 * The [Rust Compiler Testing Docs][rctd]
638 * For @bors, [this cheat sheet][cheatsheet] is helpful (Remember to replace `@homu` with `@bors` in the commands that you use.)
639 * **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly)
640 * Don't be afraid to ask! The Rust community is friendly and helpful.
641
642 [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/about-this-guide.html
643 [gdfrustc]: http://manishearth.github.io/rust-internals-docs/rustc/
644 [gsearchdocs]: https://www.google.com/search?q=site:doc.rust-lang.org+your+query+here
645 [rif]: http://internals.rust-lang.org
646 [rr]: https://doc.rust-lang.org/book/README.html
647 [rustforge]: https://forge.rust-lang.org/
648 [tlgba]: http://tomlee.co/2014/04/a-more-detailed-tour-of-the-rust-compiler/
649 [ro]: http://www.rustaceans.org/
650 [rctd]: ./src/test/COMPILER_TESTS.md
651 [cheatsheet]: https://buildbot2.rust-lang.org/homu/