CONTRIBUTING.md

   1 ## How to submit a bug report
   2
   3 If you're just reporting a bug, please see:
   4
   5 http://doc.rust-lang.org/complement-bugreport.html
   6
   7 ## Submitting an issue
   8
   9 Please submit issues here for bug reports or implementation details. For feature
  10 requests, language changes, or major changes to the libraries, please submit an
  11 issue against the [RFCs repository](https://github.com/rust-lang/rfcs).
  12
  13 ## Pull request procedure
  14
  15 Pull requests should be targeted at Rust's `master` branch.
  16 Before pushing to your Github repo and issuing the pull request,
  17 please do two things:
  18
  19 1. [Rebase](http://git-scm.com/book/en/Git-Branching-Rebasing) your
  20    local changes against the `master` branch. Resolve any conflicts
  21    that arise.
  22
  23 2. Run the full Rust test suite with the `make check` command.  You're
  24    not off the hook even if you just stick to documentation; code
  25    examples in the docs are tested as well! Although for simple
  26    wording or grammar fixes, this is probably unnecessary.
  27
  28 Pull requests will be treated as "review requests", and we will give
  29 feedback we expect to see corrected on
  30 [style](https://github.com/rust-lang/rust/wiki/Note-style-guide) and
  31 substance before pulling.  Changes contributed via pull request should
  32 focus on a single issue at a time, like any other.  We will not accept
  33 pull-requests that try to "sneak" unrelated changes in.
  34
  35 Normally, all pull requests must include regression tests (see
  36 [Note-testsuite](https://github.com/rust-lang/rust/wiki/Note-testsuite))
  37 that test your change.  Occasionally, a change will be very difficult
  38 to test for.  In those cases, please include a note in your commit
  39 message explaining why.
  40
  41 In the licensing header at the beginning of any files you change,
  42 please make sure the listed date range includes the current year.  For
  43 example, if it's 2014, and you change a Rust file that was created in
  44 2010, it should begin:
  45
  46 ```
  47 // Copyright 2010-2014 The Rust Project Developers.
  48 ```
  49
  50 For more details, please refer to
  51 [Note-development-policy](https://github.com/rust-lang/rust/wiki/Note-development-policy).