]> git.lizzy.rs Git - rust.git/blob - CONTRIBUTING.md
auto merge of #8357 : omasanori/rust/cleanup, r=alexcrichton
[rust.git] / CONTRIBUTING.md
1 ## Pull request procedure
2
3 Pull requests should be targeted at Rust's `master` branch.
4 Before pushing to your Github repo and issuing the pull request,
5 please do two things:
6
7 1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your
8    local changes against the `master` branch. Resolve any conflicts
9    that arise.
10
11 2. Run the full Rust test suite with the `make check` command.  You're
12    not off the hook even if you just stick to documentation; code
13    examples in the docs are tested as well!
14
15 Pull requests will be treated as "review requests", and we will give
16 feedback we expect to see corrected on
17 [style](https://github.com/mozilla/rust/wiki/Note-style-guide) and
18 substance before pulling.  Changes contributed via pull request should
19 focus on a single issue at a time, like any other.  We will not accept
20 pull-requests that try to "sneak" unrelated changes in.
21
22 Normally, all pull requests must include regression tests (see
23 [Note-testsuite](https://github.com/mozilla/rust/wiki/Note-testsuite))
24 that test your change.  Occasionally, a change will be very difficult
25 to test for.  In those cases, please include a note in your commit
26 message explaining why.
27
28 In the licensing header at the beginning of any files you change,
29 please make sure the listed date range includes the current year.  For
30 example, if it's 2013, and you change a Rust file that was created in
31 2010, it should begin:
32
33 ```
34 // Copyright 2010-2013 The Rust Project Developers.
35 ```
36
37 For more details, please refer to
38 [Note-development-policy](https://github.com/mozilla/rust/wiki/Note-development-policy).