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