Skip to content

Commit c4ca9bb

Browse files
committed
Break out the contributing notes into CONTRIBUTING.md
1 parent 09ece90 commit c4ca9bb

File tree

2 files changed

+31
-32
lines changed

2 files changed

+31
-32
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing to rustup
2+
3+
1. Fork it!
4+
2. Create your feature branch: `git checkout -b my-new-feature`
5+
3. Commit your changes: `git commit -am 'Add some feature'`
6+
4. Push to the branch: `git push origin my-new-feature`
7+
5. Submit a pull request :D
8+
9+
For developing on `rustup` itself, you may want to install into a temporary
10+
directory, with a series of commands similar to this:
11+
12+
```bash
13+
$ cargo build
14+
$ mkdir home
15+
$ RUSTUP_HOME=home CARGO_HOME=home target/debug/rustup-init --no-modify-path -y
16+
```
17+
18+
You can then try out `rustup` with your changes by running `home/bin/rustup`, without
19+
affecting any existing installation. Remember to keep those two environment variables
20+
set when running your compiled `rustup-init` or the toolchains it installs, but _unset_
21+
when rebuilding `rustup` itself.
22+
23+
We use `rustfmt` to keep our codebase consistently formatted. Please ensure that
24+
you have correctly formatted your code (most editors will do this automatically
25+
when saving) or it may not pass the CI tests.
26+
27+
Unless you explicitly state otherwise, any contribution intentionally
28+
submitted for inclusion in the work by you, as defined in the
29+
Apache-2.0 license, shall be dual licensed as in the README, without any
30+
additional terms or conditions.

README.md

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ And it runs on all platforms Rust supports, including Windows.
3232
* [Security](#security)
3333
* [FAQ](#faq)
3434
* [License](#license)
35-
* [Contributing](#contributing)
35+
* [Contributing](CONTRIBUTING.md)
3636

3737
## Installation
3838

@@ -706,37 +706,6 @@ Licensed under either of
706706

707707
at your option.
708708

709-
## Contributing
710-
711-
1. Fork it!
712-
2. Create your feature branch: `git checkout -b my-new-feature`
713-
3. Commit your changes: `git commit -am 'Add some feature'`
714-
4. Push to the branch: `git push origin my-new-feature`
715-
5. Submit a pull request :D
716-
717-
For developing on `rustup` itself, you may want to install into a temporary
718-
directory, with a series of commands similar to this:
719-
720-
```bash
721-
$ cargo build
722-
$ mkdir home
723-
$ RUSTUP_HOME=home CARGO_HOME=home target/debug/rustup-init --no-modify-path -y
724-
```
725-
726-
You can then try out `rustup` with your changes by running `home/bin/rustup`, without
727-
affecting any existing installation. Remember to keep those two environment variables
728-
set when running your compiled `rustup-init` or the toolchains it installs, but _unset_
729-
when rebuilding `rustup` itself.
730-
731-
We use `rustfmt` to keep our codebase consistently formatted. Please ensure that
732-
you have correctly formatted your code (most editors will do this automatically
733-
when saving) or it may not pass the CI tests.
734-
735-
Unless you explicitly state otherwise, any contribution intentionally
736-
submitted for inclusion in the work by you, as defined in the
737-
Apache-2.0 license, shall be dual licensed as above, without any
738-
additional terms or conditions.
739-
740709
<!-- Badges -->
741710
[travis-build-status]: https://travis-ci.org/rust-lang/rustup.rs
742711
[travis-build-status-svg]: https://img.shields.io/travis/rust-lang/rustup.rs.svg

0 commit comments

Comments
 (0)