From: Aleksey Kladov <aleksey.kladov@gmail.com>
Date: Sun, 3 Sep 2017 09:47:49 +0000 (+0300)
Subject: Add CONTRIBUTING.md
X-Git-Tag: archive/raspbian/0.35.0-2+rpi1~3^2^2^2^2^2^2^2~22^2~6^2~67^2
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=d11a429ded93659933ab58d985eb0a9e1ce5e971;p=cargo.git

Add CONTRIBUTING.md
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..cc3779189
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,39 @@
+# Contributing to Cargo
+
+Thank you for your interest in contributing to Cargo! Good places to
+start are this document, [ARCHITECTURE.md](ARCHITECTURE.md), which
+describes high-level structure of Cargo and [E-easy] bugs on the
+issue tracker.
+
+As a reminder, all contributors are expected to follow our [Code of Conduct].
+
+[E-easy]: https://github.com/rust-lang/cargo/labels/E-easy
+[Code of Conduct]: https://www.rust-lang.org/conduct.html
+
+
+## Running the tests
+
+To run Cargo's tests, use `cargo test`. If you do not have the cross-compilers
+installed locally, ignore the cross-compile test failures, or disable them by
+using `CFG_DISABLE_CROSS_TESTS=1 cargo test`. Note that some tests are enabled
+only on nightly toolchain.
+
+
+## Contributing to the Docs
+
+To contribute to the docs, all you need to do is change the markdown files in
+the `src/doc` directory. To view the rendered version of changes you have
+made locally, run:
+
+```sh
+sh src/ci/dox.sh
+open target/doc/index.html
+```
+
+
+## Getting help
+
+If you need some pointers about Cargo's internals, feel free to ask questions
+on the relevant issue or on the [IRC].
+
+[IRC]: https://kiwiirc.com/client/irc.mozilla.org/cargo
diff --git a/README.md b/README.md
index 297452e44..b853fdeae 100644
--- a/README.md
+++ b/README.md
@@ -34,12 +34,6 @@ With `cargo` already installed, you can simply run:
 cargo build --release
 ```
 
-## Running the tests
-
-To run cargo's tests, use `cargo test`. If you do not have the cross-compilers
-installed locally, ignore the cross-compile test failures, or disable them by
-using `CFG_DISABLE_CROSS_TESTS=1 cargo test`.
-
 ## Adding new subcommands to Cargo
 
 Cargo is designed to be extensible with new subcommands without having to modify
@@ -48,16 +42,6 @@ a list of known community-developed subcommands.
 
 [third-party-subcommands]: https://github.com/rust-lang/cargo/wiki/Third-party-cargo-subcommands
 
-## Contributing to the Docs
-
-To contribute to the docs, all you need to do is change the markdown files in
-the `src/doc` directory. To view the rendered version of changes you have
-made locally, run:
-
-```sh
-sh src/ci/dox.sh
-open target/doc/index.html
-```
 
 ## Releases
 
@@ -95,6 +79,12 @@ Please report all issues on the github [issue tracker][issues].
 
 [issues]: https://github.com/rust-lang/cargo/issues
 
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+
 ## License
 
 Cargo is primarily distributed under the terms of both the MIT license