Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,14 @@
Contributing documentation has moved to the **[Cargo Contributor Guide]**.

[Cargo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/

## Before hacking on Cargo

We encourage people to discuss their design before hacking on code. Typically,
you [file an issue] or start a thread on the [internals forum] before submitting
a pull request. Please read [the process] of how features and bugs are managed
in Cargo.

[internals forum]: https://internals.rust-lang.org/c/tools-and-infrastructure/cargo
[file an issue]: https://github.com/rust-lang/cargo/issues
[the process]: https://doc.crates.io/contrib/process/index.html
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

Cargo downloads your Rust project’s dependencies and compiles your project.

Learn more at https://doc.rust-lang.org/cargo/
**To start using Cargo**, learn more at [The Cargo Book].

**To start developing Cargo itself**, read the [Cargo Contributor Guide].

[The Cargo Book]: https://doc.rust-lang.org/cargo/
[Cargo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/

## Code Status

Expand Down Expand Up @@ -69,8 +74,6 @@ Please report all issues on the GitHub [issue tracker][issues].
See the **[Cargo Contributor Guide]** for a complete introduction
to contributing to Cargo.

[Cargo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/

## License

Cargo is primarily distributed under the terms of both the MIT license
Expand Down
13 changes: 13 additions & 0 deletions src/doc/contrib/src/process/working-on-cargo.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,23 @@
This chapter gives an overview of how to build Cargo, make a change, and
submit a Pull Request.

0. [Before hacking on Cargo.](#before-hacking-on-cargo)
1. [Check out the Cargo source.](#checkout-out-the-source)
2. [Building Cargo.](#building-cargo)
3. [Making a change.](#making-a-change)
4. [Writing and running tests.](../tests/index.md)
5. [Submitting a Pull Request.](#submitting-a-pull-request)
6. [The merging process.](#the-merging-process)

## Before hacking on Cargo

We encourage people to discuss their design before hacking on code. This gives
the Cargo team a chance to know your idea more. Sometimes after a discussion,
we even find a way to solve the problem without coding! Typically, you
[file an issue] or start a thread on the [internals forum] before submitting a
pull request. Please read [the process] of how features and bugs are managed in
Cargo.

## Checkout out the source

We use the "fork and pull" model [described here][development-models], where
Expand Down Expand Up @@ -143,3 +153,6 @@ more information on how Cargo releases are made.
[homu-cargo]: https://buildbot2.rust-lang.org/homu/queue/cargo
[homu-rust]: https://buildbot2.rust-lang.org/homu/queue/rust
[release chapter]: release.md
[internals forum]: https://internals.rust-lang.org/c/tools-and-infrastructure/cargo
[file an issue]: https://github.com/rust-lang/cargo/issues
[the process]: index.md