Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Tweak the CONTRIBUTING.md file.

  • Loading branch information...
commit 0bc13a240126d9758a52956be13f933f68da1676 1 parent 3c4e30b
Graydon Hoare graydon authored
Showing with 14 additions and 5 deletions.
  1. +14 −5 CONTRIBUTING.md
19 CONTRIBUTING.md
View
@@ -1,15 +1,24 @@
## Pull request procedure
-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:
+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:
1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your local changes against the `incoming` branch. Resolve any conflicts that arise.
-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!
+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!
-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.
+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 accept pull-requests that try to "sneak" unrelated changes in.
-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.
+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.
-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:
+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:
```
// Copyright 2010-2013 The Rust Project Developers.
Please sign in to comment.
Something went wrong with that request. Please try again.