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