From 0bc13a240126d9758a52956be13f933f68da1676 Mon Sep 17 00:00:00 2001 From: Graydon Hoare Date: Fri, 1 Feb 2013 17:34:09 -0800 Subject: [PATCH] Tweak the CONTRIBUTING.md file. --- CONTRIBUTING.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39183eafe9e..c6e9478713d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.