rust
/
cargo
mirror of https://github.com/rust-lang/cargo
0
0
Fork 0
Code Issues Releases Wiki Activity

Add CONTRIBUTING.md

This commit is contained in:
Aleksey Kladov 2017-09-03 12:47:49 +03:00
parent 8ee43410be
commit d11a429ded
2 changed files with 45 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
CONTRIBUTING.md Normal file
View File

@ -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

22
README.md
View File

@ -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