Skip to content

Commit 0bc13a2

Browse files
committed
Tweak the CONTRIBUTING.md file.
1 parent 3c4e30b commit 0bc13a2

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
## Pull request procedure
22

3-
Pull requests should be targeted at Rust's `incoming` branch (note that by default Github will aim them at the `master` branch) -- see "Changing The Commit Range and Destination Repository" in Github's documentation on [pull requests](https://help.github.com/articles/using-pull-requests). 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 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:
46

57
1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local changes against the `incoming` branch. Resolve any conflicts that arise.
6-
2. Run the full Rust test suite with the `make check` command. You're not off the hook even if you just stick to documentation; code examples in the docs are tested as well!
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!
710

8-
Pull requests will be treated as "review requests", 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. Changes contributed via pull request should focus on a single issue at a time, like any other. We will not look kindly on pull-requests that try to "sneak" unrelated changes in.
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 look accept pull-requests that try to "sneak" unrelated changes in.
915

10-
Normally, all pull requests must include regression tests (see [Note-testsuite](https://github.com/mozilla/rust/wiki/Note-testsuite)) that test your change. Occasionally, a change will be very difficult to test for. In those cases, please include a note in your commit message explaining why.
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.
1119

12-
In the licensing header at the beginning of any files you change, please make sure the listed date range includes the current year. For example, if it's 2013, and you change a Rust file that was created in 2010, it should begin:
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:
1322

1423
```
1524
// Copyright 2010-2013 The Rust Project Developers.

0 commit comments

Comments
 (0)