diff options
| author | bors <bors@rust-lang.org> | 2013-06-05 08:55:50 -0700 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2013-06-05 08:55:50 -0700 |
| commit | 38b1d60e0d86bc9b252bb09c1e4cb1ca9f8b2921 (patch) | |
| tree | 98a2bce18e5a41721591f21e747b98ad1faa4e4c | |
| parent | de3000af8fa2aa9965453a2b8909c3f52244fb2e (diff) | |
| parent | 49364210315fc8b4896932c2c10acbf975180c83 (diff) | |
auto merge of #6952 : artagnon/rust/contributing-wrap, r=bstrie
Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
| -rw-r--r-- | CONTRIBUTING.md | 47 |
1 files changed, 31 insertions, 16 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d934e38c35d..3cba6f2891a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,27 +1,42 @@ ## 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! +1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your + local changes against the `incoming` branch. Resolve any conflicts + that arise. -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 accept pull-requests that try to "sneak" unrelated changes in. +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! -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. +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 accept +pull-requests that try to "sneak" unrelated changes in. -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: +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: ``` // Copyright 2010-2013 The Rust Project Developers. ``` -For more details, please refer to [Note-development-policy](https://github.com/mozilla/rust/wiki/Note-development-policy). \ No newline at end of file +For more details, please refer to +[Note-development-policy](https://github.com/mozilla/rust/wiki/Note-development-policy). |
