Skip to content

Commit 19f3188

Browse files
committed
Auto merge of #10468 - weihanglo:contrib-doc-refine, r=ehuss
Refine the contributor guide
2 parents 65c8266 + 2d06e57 commit 19f3188

File tree

3 files changed

+30
-3
lines changed

3 files changed

+30
-3
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,14 @@
33
Contributing documentation has moved to the **[Cargo Contributor Guide]**.
44

55
[Cargo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/
6+
7+
## Before hacking on Cargo
8+
9+
We encourage people to discuss their design before hacking on code. Typically,
10+
you [file an issue] or start a thread on the [internals forum] before submitting
11+
a pull request. Please read [the process] of how features and bugs are managed
12+
in Cargo.
13+
14+
[internals forum]: https://internals.rust-lang.org/c/tools-and-infrastructure/cargo
15+
[file an issue]: https://github.com/rust-lang/cargo/issues
16+
[the process]: https://doc.crates.io/contrib/process/index.html

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22

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

5-
Learn more at https://doc.rust-lang.org/cargo/
5+
**To start using Cargo**, learn more at [The Cargo Book].
6+
7+
**To start developing Cargo itself**, read the [Cargo Contributor Guide].
8+
9+
[The Cargo Book]: https://doc.rust-lang.org/cargo/
10+
[Cargo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/
611

712
## Code Status
813

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

72-
[Cargo Contributor Guide]: https://rust-lang.github.io/cargo/contrib/
73-
7477
## License
7578

7679
Cargo is primarily distributed under the terms of both the MIT license

src/doc/contrib/src/process/working-on-cargo.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,23 @@
33
This chapter gives an overview of how to build Cargo, make a change, and
44
submit a Pull Request.
55

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

14+
## Before hacking on Cargo
15+
16+
We encourage people to discuss their design before hacking on code. This gives
17+
the Cargo team a chance to know your idea more. Sometimes after a discussion,
18+
we even find a way to solve the problem without coding! Typically, you
19+
[file an issue] or start a thread on the [internals forum] before submitting a
20+
pull request. Please read [the process] of how features and bugs are managed in
21+
Cargo.
22+
1323
## Checkout out the source
1424

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

0 commit comments

Comments
 (0)