2015-02-13 11:26:44 -06:00
|
|
|
|
# Contributing to Rust
|
2013-10-21 14:10:57 -05:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
Thank you for your interest in contributing to Rust! There are many ways to
|
|
|
|
|
contribute, and we appreciate all of them. This document is a bit long, so here's
|
|
|
|
|
links to the major sections:
|
2013-10-21 14:10:57 -05:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
* [Feature Requests](#feature-requests)
|
|
|
|
|
* [Bug Reports](#bug-reports)
|
2016-01-25 08:07:10 -06:00
|
|
|
|
* [The Build System](#the-build-system)
|
2015-02-13 11:26:44 -06:00
|
|
|
|
* [Pull Requests](#pull-requests)
|
|
|
|
|
* [Writing Documentation](#writing-documentation)
|
|
|
|
|
* [Issue Triage](#issue-triage)
|
|
|
|
|
* [Out-of-tree Contributions](#out-of-tree-contributions)
|
2015-09-11 18:21:11 -05:00
|
|
|
|
* [Helpful Links and Information](#helpful-links-and-information)
|
2013-10-21 14:10:57 -05:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
If you have questions, please make a post on [internals.rust-lang.org][internals] or
|
|
|
|
|
hop on [#rust-internals][pound-rust-internals].
|
2014-09-21 19:46:24 -05:00
|
|
|
|
|
2015-02-18 21:53:00 -06:00
|
|
|
|
As a reminder, all contributors are expected to follow our [Code of Conduct][coc].
|
2014-09-21 19:46:24 -05:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
[pound-rust-internals]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals
|
2015-08-09 16:15:05 -05:00
|
|
|
|
[internals]: https://internals.rust-lang.org
|
|
|
|
|
[coc]: https://www.rust-lang.org/conduct.html
|
2012-12-27 16:58:45 -06:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
## Feature Requests
|
2012-12-27 16:58:45 -06:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
To request a change to the way that the Rust language works, please open an
|
|
|
|
|
issue in the [RFCs repository](https://github.com/rust-lang/rfcs/issues/new)
|
|
|
|
|
rather than this one. New features and other significant language changes
|
|
|
|
|
must go through the RFC process.
|
2012-12-27 16:58:45 -06:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
## Bug Reports
|
2012-12-27 16:58:45 -06:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
While bugs are unfortunate, they're a reality in software. We can't fix what we
|
|
|
|
|
don't know about, so please report liberally. If you're not sure if something
|
|
|
|
|
is a bug or not, feel free to file a bug anyway.
|
2012-12-27 16:58:45 -06:00
|
|
|
|
|
2015-11-06 16:05:19 -06:00
|
|
|
|
**If you believe reporting your bug publicly represents a security risk to Rust users,
|
|
|
|
|
please follow our [instructions for reporting security vulnerabilities](https://www.rust-lang.org/security.html)**.
|
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
If you have the chance, before reporting a bug, please [search existing
|
|
|
|
|
issues](https://github.com/rust-lang/rust/search?q=&type=Issues&utf8=%E2%9C%93),
|
|
|
|
|
as it's possible that someone else has already reported your error. This doesn't
|
|
|
|
|
always work, and sometimes it's hard to know what to search for, so consider this
|
|
|
|
|
extra credit. We won't mind if you accidentally file a duplicate report.
|
2013-06-05 09:04:39 -05:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
Opening an issue is as easy as following [this
|
|
|
|
|
link](https://github.com/rust-lang/rust/issues/new) and filling out the fields.
|
|
|
|
|
Here's a template that you can use to file a bug, though it's not necessary to
|
|
|
|
|
use it exactly:
|
2013-01-29 13:07:02 -06:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
<short summary of the bug>
|
|
|
|
|
|
|
|
|
|
I tried this code:
|
|
|
|
|
|
|
|
|
|
<code sample that causes the bug>
|
|
|
|
|
|
|
|
|
|
I expected to see this happen: <explanation>
|
|
|
|
|
|
|
|
|
|
Instead, this happened: <explanation>
|
|
|
|
|
|
|
|
|
|
## Meta
|
|
|
|
|
|
|
|
|
|
`rustc --version --verbose`:
|
|
|
|
|
|
|
|
|
|
Backtrace:
|
|
|
|
|
|
|
|
|
|
All three components are important: what you did, what you expected, what
|
|
|
|
|
happened instead. Please include the output of `rustc --version --verbose`,
|
|
|
|
|
which includes important information about what platform you're on, what
|
|
|
|
|
version of Rust you're using, etc.
|
|
|
|
|
|
|
|
|
|
Sometimes, a backtrace is helpful, and so including that is nice. To get
|
|
|
|
|
a backtrace, set the `RUST_BACKTRACE` environment variable. The easiest way
|
|
|
|
|
to do this is to invoke `rustc` like this:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
$ RUST_BACKTRACE=1 rustc ...
|
2013-01-29 13:07:02 -06:00
|
|
|
|
```
|
|
|
|
|
|
2016-01-25 08:07:10 -06:00
|
|
|
|
## The Build System
|
|
|
|
|
|
2016-01-26 08:41:29 -06:00
|
|
|
|
Rust's build system allows you to bootstrap the compiler, run tests &
|
|
|
|
|
benchmarks, generate documentation, install a fresh build of Rust, and more.
|
|
|
|
|
It's your best friend when working on Rust, allowing you to compile & test
|
|
|
|
|
your contributions before submission.
|
|
|
|
|
|
|
|
|
|
All the configuration for the build system lives in [the `mk` directory][mkdir]
|
|
|
|
|
in the project root. It can be hard to follow in places, as it uses some
|
|
|
|
|
advanced Make features which make for some challenging reading. If you have
|
|
|
|
|
questions on the build system internals, try asking in
|
|
|
|
|
[`#rust-internals`][pound-rust-internals].
|
2016-01-25 08:07:10 -06:00
|
|
|
|
|
|
|
|
|
[mkdir]: https://github.com/rust-lang/rust/tree/master/mk/
|
|
|
|
|
|
|
|
|
|
### Configuration
|
|
|
|
|
|
|
|
|
|
Before you can start building the compiler you need to configure the build for
|
|
|
|
|
your system. In most cases, that will just mean using the defaults provided
|
|
|
|
|
for Rust. Configuring involves invoking the `configure` script in the project
|
|
|
|
|
root.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
./configure
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
There are large number of options accepted by this script to alter the
|
|
|
|
|
configuration used later in the build process. Some options to note:
|
|
|
|
|
|
|
|
|
|
- `--enable-debug` - Build a debug version of the compiler (disables optimizations)
|
2016-01-26 08:14:09 -06:00
|
|
|
|
- `--enable-optimize` - Enable optimizations (can be used with `--enable-debug`
|
|
|
|
|
to make a debug build with optimizations)
|
2016-01-25 08:07:10 -06:00
|
|
|
|
- `--disable-valgrind-rpass` - Don't run tests with valgrind
|
2016-01-26 08:14:09 -06:00
|
|
|
|
- `--enable-clang` - Prefer clang to gcc for building dependencies (e.g., LLVM)
|
2016-01-25 08:07:10 -06:00
|
|
|
|
- `--enable-ccache` - Invoke clang/gcc with ccache to re-use object files between builds
|
2016-01-26 08:14:09 -06:00
|
|
|
|
- `--enable-compiler-docs` - Build compiler documentation
|
2016-01-25 08:07:10 -06:00
|
|
|
|
|
|
|
|
|
To see a full list of options, run `./configure --help`.
|
|
|
|
|
|
|
|
|
|
### Useful Targets
|
|
|
|
|
|
|
|
|
|
Some common make targets are:
|
|
|
|
|
|
|
|
|
|
- `make rustc-stage1` - build up to (and including) the first stage. For most
|
|
|
|
|
cases we don't need to build the stage2 compiler, so we can save time by not
|
|
|
|
|
building it. The stage1 compiler is a fully functioning compiler and
|
|
|
|
|
(probably) will be enough to determine if your change works as expected.
|
|
|
|
|
- `make check` - build the full compiler & run all tests (takes a while). This
|
|
|
|
|
is what gets run by the continuous integration system against your pull
|
|
|
|
|
request. You should run this before submitting to make sure your tests pass
|
|
|
|
|
& everything builds in the correct manner.
|
|
|
|
|
- `make check-stage1-std NO_REBUILD=1` - test the standard library without
|
|
|
|
|
rebuilding the entire compiler
|
2016-02-01 17:58:59 -06:00
|
|
|
|
- `make check TESTNAME=<substring-of-test-name>` - Run a matching set of tests.
|
2016-03-13 14:57:24 -05:00
|
|
|
|
- `TESTNAME` should be a substring of the tests to match against e.g. it could
|
|
|
|
|
be the fully qualified test name, or just a part of it.
|
2016-02-01 00:04:39 -06:00
|
|
|
|
`TESTNAME=collections::hash::map::test_map::test_capacity_not_less_than_len`
|
2016-02-01 17:57:24 -06:00
|
|
|
|
or `TESTNAME=test_capacity_not_less_than_len`.
|
|
|
|
|
- `make check-stage1-rpass TESTNAME=<substring-of-test-name>` - Run a single
|
2016-01-25 08:07:10 -06:00
|
|
|
|
rpass test with the stage1 compiler (this will be quicker than running the
|
|
|
|
|
command above as we only build the stage1 compiler, not the entire thing).
|
|
|
|
|
You can also leave off the `-rpass` to run all stage1 test types.
|
2016-01-26 08:14:09 -06:00
|
|
|
|
- `make check-stage1-coretest` - Run stage1 tests in `libcore`.
|
2016-01-25 08:07:10 -06:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
## Pull Requests
|
2015-01-02 17:41:47 -06:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
Pull requests are the primary mechanism we use to change Rust. GitHub itself
|
|
|
|
|
has some [great documentation][pull-requests] on using the Pull Request
|
|
|
|
|
feature. We use the 'fork and pull' model described there.
|
2015-01-02 17:41:47 -06:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
[pull-requests]: https://help.github.com/articles/using-pull-requests/
|
|
|
|
|
|
|
|
|
|
Please make pull requests against the `master` branch.
|
|
|
|
|
|
2015-07-06 13:46:21 -05:00
|
|
|
|
Compiling all of `make check` can take a while. When testing your pull request,
|
|
|
|
|
consider using one of the more specialized `make` targets to cut down on the
|
|
|
|
|
amount of time you have to wait. You need to have built the compiler at least
|
|
|
|
|
once before running these will work, but that’s only one full build rather than
|
|
|
|
|
one each time.
|
|
|
|
|
|
|
|
|
|
$ make -j8 rustc-stage1 && make check-stage1
|
|
|
|
|
|
|
|
|
|
is one such example, which builds just `rustc`, and then runs the tests. If
|
|
|
|
|
you’re adding something to the standard library, try
|
|
|
|
|
|
|
|
|
|
$ make -j8 check-stage1-std NO_REBUILD=1
|
|
|
|
|
|
|
|
|
|
This will not rebuild the compiler, but will run the tests.
|
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
All pull requests are reviewed by another person. We have a bot,
|
2015-05-27 09:29:02 -05:00
|
|
|
|
@rust-highfive, that will automatically assign a random person to review your
|
|
|
|
|
request.
|
2015-02-13 11:26:44 -06:00
|
|
|
|
|
|
|
|
|
If you want to request that a specific person reviews your pull request,
|
|
|
|
|
you can add an `r?` to the message. For example, Steve usually reviews
|
|
|
|
|
documentation changes. So if you were to make a documentation change, add
|
|
|
|
|
|
|
|
|
|
r? @steveklabnik
|
|
|
|
|
|
|
|
|
|
to the end of the message, and @rust-highfive will assign @steveklabnik instead
|
|
|
|
|
of a random person. This is entirely optional.
|
|
|
|
|
|
|
|
|
|
After someone has reviewed your pull request, they will leave an annotation
|
|
|
|
|
on the pull request with an `r+`. It will look something like this:
|
|
|
|
|
|
|
|
|
|
@bors: r+ 38fe8d2
|
|
|
|
|
|
|
|
|
|
This tells @bors, our lovable integration bot, that your pull request has
|
|
|
|
|
been approved. The PR then enters the [merge queue][merge-queue], where @bors
|
|
|
|
|
will run all the tests on every platform we support. If it all works out,
|
|
|
|
|
@bors will merge your code into `master` and close the pull request.
|
|
|
|
|
|
|
|
|
|
[merge-queue]: http://buildbot.rust-lang.org/homu/queue/rust
|
|
|
|
|
|
2015-07-06 11:14:49 -05:00
|
|
|
|
Speaking of tests, Rust has a comprehensive test suite. More information about
|
|
|
|
|
it can be found
|
|
|
|
|
[here](https://github.com/rust-lang/rust-wiki-backup/blob/master/Note-testsuite.md).
|
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
## Writing Documentation
|
|
|
|
|
|
|
|
|
|
Documentation improvements are very welcome. The source of `doc.rust-lang.org`
|
|
|
|
|
is located in `src/doc` in the tree, and standard API documentation is generated
|
|
|
|
|
from the source code itself.
|
|
|
|
|
|
2015-06-30 17:57:54 -05:00
|
|
|
|
Documentation pull requests function in the same way as other pull requests,
|
|
|
|
|
though you may see a slightly different form of `r+`:
|
2015-02-13 11:26:44 -06:00
|
|
|
|
|
|
|
|
|
@bors: r+ 38fe8d2 rollup
|
|
|
|
|
|
|
|
|
|
That additional `rollup` tells @bors that this change is eligible for a 'rollup'.
|
|
|
|
|
To save @bors some work, and to get small changes through more quickly, when
|
|
|
|
|
@bors attempts to merge a commit that's rollup-eligible, it will also merge
|
|
|
|
|
the other rollup-eligible patches too, and they'll get tested and merged at
|
|
|
|
|
the same time.
|
|
|
|
|
|
2015-10-02 16:08:14 -05:00
|
|
|
|
To find documentation-related issues, sort by the [A-docs label][adocs].
|
2015-05-27 09:29:02 -05:00
|
|
|
|
|
|
|
|
|
[adocs]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AA-docs
|
|
|
|
|
|
2015-10-02 16:09:27 -05:00
|
|
|
|
In many cases, you don't need a full `make doc`. You can use `rustdoc` directly
|
|
|
|
|
to check small fixes. For example, `rustdoc src/doc/reference.md` will render
|
|
|
|
|
reference to `doc/reference.html`. The CSS might be messed up, but you can
|
|
|
|
|
verify that HTML is right.
|
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
## Issue Triage
|
|
|
|
|
|
|
|
|
|
Sometimes, an issue will stay open, even though the bug has been fixed. And
|
|
|
|
|
sometimes, the original bug may go stale because something has changed in the
|
|
|
|
|
meantime.
|
|
|
|
|
|
|
|
|
|
It can be helpful to go through older bug reports and make sure that they are
|
|
|
|
|
still valid. Load up an older issue, double check that it's still true, and
|
2015-05-27 09:29:02 -05:00
|
|
|
|
leave a comment letting us know if it is or is not. The [least recently
|
|
|
|
|
updated sort][lru] is good for finding issues like this.
|
|
|
|
|
|
|
|
|
|
Contributors with sufficient permissions on the Rust repo can help by adding
|
|
|
|
|
labels to triage issues:
|
|
|
|
|
|
|
|
|
|
* Yellow, **A**-prefixed labels state which **area** of the project an issue
|
2015-10-02 16:08:14 -05:00
|
|
|
|
relates to.
|
2015-05-27 09:29:02 -05:00
|
|
|
|
|
2016-01-14 04:47:04 -06:00
|
|
|
|
* Magenta, **B**-prefixed labels identify bugs which are **blockers**.
|
2015-05-27 09:29:02 -05:00
|
|
|
|
|
|
|
|
|
* Green, **E**-prefixed labels explain the level of **experience** necessary
|
|
|
|
|
to fix the issue.
|
|
|
|
|
|
|
|
|
|
* Red, **I**-prefixed labels indicate the **importance** of the issue. The
|
|
|
|
|
[I-nominated][inom] label indicates that an issue has been nominated for
|
2015-10-02 16:08:14 -05:00
|
|
|
|
prioritizing at the next triage meeting.
|
2015-05-27 09:29:02 -05:00
|
|
|
|
|
|
|
|
|
* Orange, **P**-prefixed labels indicate a bug's **priority**. These labels
|
|
|
|
|
are only assigned during triage meetings, and replace the [I-nominated][inom]
|
2015-10-02 16:08:14 -05:00
|
|
|
|
label.
|
2015-05-27 09:29:02 -05:00
|
|
|
|
|
|
|
|
|
* Blue, **T**-prefixed bugs denote which **team** the issue belongs to.
|
|
|
|
|
|
|
|
|
|
* Dark blue, **beta-** labels track changes which need to be backported into
|
2015-10-02 16:08:14 -05:00
|
|
|
|
the beta branches.
|
|
|
|
|
|
2015-05-27 09:29:02 -05:00
|
|
|
|
* The purple **metabug** label marks lists of bugs collected by other
|
2015-10-02 16:08:14 -05:00
|
|
|
|
categories.
|
2015-05-27 09:29:02 -05:00
|
|
|
|
|
2015-10-02 16:08:14 -05:00
|
|
|
|
If you're looking for somewhere to start, check out the [E-easy][eeasy] tag.
|
2015-02-13 11:26:44 -06:00
|
|
|
|
|
2015-05-27 09:29:02 -05:00
|
|
|
|
[inom]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AI-nominated
|
|
|
|
|
[eeasy]: https://github.com/rust-lang/rust/issues?q=is%3Aopen+is%3Aissue+label%3AE-easy
|
2015-02-13 11:26:44 -06:00
|
|
|
|
[lru]: https://github.com/rust-lang/rust/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-asc
|
|
|
|
|
|
|
|
|
|
## Out-of-tree Contributions
|
|
|
|
|
|
|
|
|
|
There are a number of other ways to contribute to Rust that don't deal with
|
|
|
|
|
this repository.
|
|
|
|
|
|
|
|
|
|
Answer questions in [#rust][pound-rust], or on [users.rust-lang.org][users],
|
|
|
|
|
or on [StackOverflow][so].
|
|
|
|
|
|
|
|
|
|
Participate in the [RFC process](https://github.com/rust-lang/rfcs).
|
|
|
|
|
|
|
|
|
|
Find a [requested community library][community-library], build it, and publish
|
|
|
|
|
it to [Crates.io](http://crates.io). Easier said than done, but very, very
|
|
|
|
|
valuable!
|
2015-01-02 17:41:47 -06:00
|
|
|
|
|
2015-02-13 11:26:44 -06:00
|
|
|
|
[pound-rust]: http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust
|
2015-08-09 16:15:05 -05:00
|
|
|
|
[users]: https://users.rust-lang.org/
|
2015-02-13 11:26:44 -06:00
|
|
|
|
[so]: http://stackoverflow.com/questions/tagged/rust
|
|
|
|
|
[community-library]: https://github.com/rust-lang/rfcs/labels/A-community-library
|
2015-09-11 18:21:11 -05:00
|
|
|
|
|
|
|
|
|
## Helpful Links and Information
|
|
|
|
|
|
|
|
|
|
For people new to Rust, and just starting to contribute, or even for
|
|
|
|
|
more seasoned developers, some useful places to look for information
|
|
|
|
|
are:
|
|
|
|
|
|
|
|
|
|
* The [Rust Internals forum][rif], a place to ask questions and
|
|
|
|
|
discuss Rust's internals
|
|
|
|
|
* The [generated documentation for rust's compiler][gdfrustc]
|
2015-10-02 07:36:27 -05:00
|
|
|
|
* The [rust reference][rr], even though it doesn't specifically talk about Rust's internals, it's a great resource nonetheless
|
2015-09-11 18:21:11 -05:00
|
|
|
|
* Although out of date, [Tom Lee's great blog article][tlgba] is very helpful
|
|
|
|
|
* [rustaceans.org][ro] is helpful, but mostly dedicated to IRC
|
2015-09-12 10:02:01 -05:00
|
|
|
|
* The [Rust Compiler Testing Docs][rctd]
|
2015-09-14 09:28:06 -05:00
|
|
|
|
* For @bors, [this cheat sheet][cheatsheet] is helpful (Remember to replace `@homu` with `@bors` in the commands that you use.)
|
2015-10-02 07:36:27 -05:00
|
|
|
|
* **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly)
|
2015-09-11 18:21:11 -05:00
|
|
|
|
* Don't be afraid to ask! The Rust community is friendly and helpful.
|
|
|
|
|
|
|
|
|
|
[gdfrustc]: http://manishearth.github.io/rust-internals-docs/rustc/
|
2015-12-23 14:42:36 -06:00
|
|
|
|
[gsearchdocs]: https://www.google.com/search?q=site:doc.rust-lang.org+your+query+here
|
2015-09-11 18:21:11 -05:00
|
|
|
|
[rif]: http://internals.rust-lang.org
|
|
|
|
|
[rr]: https://doc.rust-lang.org/book/README.html
|
|
|
|
|
[tlgba]: http://tomlee.co/2014/04/03/a-more-detailed-tour-of-the-rust-compiler/
|
|
|
|
|
[ro]: http://www.rustaceans.org/
|
2015-09-12 10:02:01 -05:00
|
|
|
|
[rctd]: ./COMPILER_TESTS.md
|
2015-09-14 09:28:06 -05:00
|
|
|
|
[cheatsheet]: http://buildbot.rust-lang.org/homu/
|