Contributing to rustup
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Test it:
cargo test --features=test
- Lint it!
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
For developing onrustup
itself, you may want to install into a temporarydirectory, with a series of commands similar to this:
cargo buildmkdir homeRUSTUP_HOME=home CARGO_HOME=home target/debug/rustup-init --no-modify-path -y
You can then try outrustup
with your changes by runninghome/bin/rustup
, withoutaffecting any existing installation. Remember to keep those two environment variablesset when running your compiledrustup-init
or the toolchains it installs, butunsetwhen rebuildingrustup
itself.
If you wish to install your new build to try out longer term in your home directorythen you can runcargo dev-install
which is an alias in.cargo/config
whichrunscargo run -- --no-modify-path -y
to install your build into your homedir.
We userustfmt
to keep our codebase consistently formatted. Please ensure thatyou have correctly formatted your code (most editors will do this automaticallywhen saving) or it may not pass the CI tests.
If you are moving, renaming or removing an existing mdBook page, please use mdBook’soutput.html.redirect
feature to ensure that the old URL gets redirected.
Unless you explicitly state otherwise, any contribution intentionallysubmitted for inclusion in the work by you, as defined in theApache-2.0 license, shall be dual licensed as in the README, without anyadditional terms or conditions.