Skip to content
This repository was archived by the owner on Sep 30, 2020. It is now read-only.

Commit 8dd40f6

Browse files
committed
Address feedback on contributing page
1 parent 645eca6 commit 8dd40f6

File tree

1 file changed

+18
-21
lines changed

1 file changed

+18
-21
lines changed

contribute.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You've started learning Rust. You love it, and you want to be a part
99
of it. If you're not sure how to get involved, then this page
1010
will help.
1111

12-
**Just want to report a bug in Rust?** [Follow the bug reporting
12+
**Found a bug and need to report it?** [Follow the bug reporting
1313
guide][bugs]. Thanks in advance!
1414

1515
Rust is an expansive system of projects, the most prominent of which
@@ -59,10 +59,10 @@ look for the [E-easy] or [E-mentor] labels. These are meant to be
5959
approachable for new Rust programmers.
6060

6161
On `E-mentor` issues an experienced Rust developer has volunteered in
62-
the comments to mentor you through the solving the issue and
63-
[submitting the fix GitHub pull request][pull]. Contact them about the
64-
issue, on the issue tracker by [@mentioning] their name, on IRC, or
65-
through email. Note that Rust developers get a lot of notifications
62+
the comments to mentor you through solving the issue and [submitting
63+
the fix via GitHub pull request][pull]. Contact them about the issue,
64+
on the issue tracker by [@mentioning] their name in a comment, on IRC,
65+
or through email. Note that Rust developers get a lot of notifications
6666
and it is easy to miss some; don't hesitate to hunt them down by
6767
whatever means necessary!
6868

@@ -84,7 +84,7 @@ project. Ask a [team member][team].
8484
Once you've found your way around the project and have created a few
8585
pull requests in a particular area, consider reviewing others' pull
8686
requests: good reviewership is a rare skill and always appreciated. No
87-
prior permission is needed &emdash; just start constructively and politely
87+
prior permission is needed — just start constructively and politely
8888
commenting on pull requests that interest you. If you want training
8989
on conducting good code reviews [read this guide][reviews].
9090

@@ -96,14 +96,13 @@ TODO: @nrc says suggesting everybody review w/o training is bad
9696
<a name="docs"></a>
9797
## Documentation
9898

99-
Documentation is never good enough and there's never enough of it,
100-
writing documentation is a valuable way to contribute. Many aspects of
101-
Rust's documentation don't require deep knowledge to improve, and
102-
writing, reviewing, and editing documentation are great ways to learn
103-
Rust. Furthermore, improvements to documentation are easy to identify
104-
and limitless. Don't like the way something reads? Discover some
105-
information that wasn't documented? Your pull request will be
106-
gleefully embraced.
99+
Documentation is never good enough and there's never enough of it.
100+
Many aspects of Rust's documentation don't require deep knowledge to
101+
improve, and writing, reviewing, and editing documentation are great
102+
ways to learn Rust. Furthermore, improvements to documentation are
103+
easy to identify and limitless. Don't like the way something reads?
104+
Discover some information that wasn't documented? Your pull request
105+
will be gleefully embraced.
107106

108107
***The most impactful documentation you can write is [for the crates
109108
that make up the Rust ecosystem][crate_docs]***. While the in-tree
@@ -288,12 +287,11 @@ Rust to LLVM IR; [A-debuginfo], generation of metadata used by debuggers;
288287
issues with the standard library; [A-macros] and [A-syntaxext], both
289288
related to syntax extensions; and [A-typesystem], on the topic of types.
290289

291-
There is no well-maintained guide to the architecture of the
292-
compiler, but [there is a small overview in-tree][rustc-guide], and
293-
individuals [occassionally blog what they've learned of
294-
rustc][rustc-tour]. The [API documentation for the crates that make up
295-
the compiler][internals-docs] can help with navigating the code, as
296-
can the source code browser [Rust DXR]. The [guide to the Rust test
290+
There is no well-maintained guide to the architecture of the compiler,
291+
but [there is a small overview in-tree][rustc-guide]. The [API
292+
documentation for the crates that make up the
293+
compiler][internals-docs] can help with navigating the code, as can
294+
the source code browser [Rust DXR]. The [guide to the Rust test
297295
suite][testsuite] will teach you how to exercise the Rust build system
298296
effectively, as will running [`make tips`][tips] at the command line.
299297

@@ -439,7 +437,6 @@ TODO: some of this RFC description could probably go in the RFC readme
439437
[rust-rosetta]: https://github.com/Hoverbear/rust-rosetta
440438
[rustc-guide]: https://github.com/rust-lang/rust/blob/master/src/librustc/README.md
441439
[rustc-perf]: http://ncameron.org/perf-rustc/
442-
[rustc-tour]: http://tomlee.co/2014/04/03/a-more-detailed-tour-of-the-rust-compiler/
443440
[rustfmt]: https://github.com/nrc/rustfmt
444441
[src/doc]: https://github.com/rust-lang/rust/tree/master/src/doc
445442
[std]: http://doc.rust-lang.org/std/index.html

0 commit comments

Comments
 (0)