Skip to content

Commit 8b8df62

Browse files
committed
Tiding up the CONTRIBUTING.md document.
1 parent c433f5e commit 8b8df62

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Thank you for your interest in contributing to Rust! There are many ways to
44
contribute, and we appreciate all of them. This document is a bit long, so here
5-
are links to the major sections:
5+
are some links to the major sections:
66

77
* [Feature Requests](#feature-requests)
88
* [Bug Reports](#bug-reports)
@@ -13,8 +13,9 @@ are links to the major sections:
1313
* [Out-of-tree Contributions](#out-of-tree-contributions)
1414
* [Helpful Links and Information](#helpful-links-and-information)
1515

16-
If you have questions, please make a post on [internals.rust-lang.org][internals]
17-
or hop on [#rust-internals][pound-rust-internals].
16+
If you have questions, please make a post on
17+
[internals.rust-lang.org][internals] or hop on
18+
[#rust-internals][pound-rust-internals].
1819

1920
As a reminder, all contributors are expected to follow our
2021
[Code of Conduct][coc].
@@ -101,12 +102,12 @@ Before you can start building the compiler you need to configure the build for
101102
your system. In most cases, that will just mean using the defaults provided
102103
for Rust.
103104

104-
To change configuration, you must copy the file `src/bootstrap/config.toml.example`
105-
to `config.toml` in the directory from which you will be running the build, and
106-
change the settings provided.
105+
To change configuration, you must copy the file
106+
`src/bootstrap/config.toml.example` to `config.toml` in the directory from which
107+
you will be running the build, and change the settings provided.
107108

108-
There are large number of options provided in this config file that will alter the
109-
configuration used in the build process. Some options to note:
109+
There are large number of options provided in this config file that will alter
110+
the configuration used in the build process. Some options to note:
110111

111112
#### `[llvm]`:
112113
- `ccache = true` - Use ccache when building llvm
@@ -116,7 +117,8 @@ configuration used in the build process. Some options to note:
116117

117118
#### `[rust]`:
118119
- `debuginfo = true` - Build a compiler with debuginfo
119-
- `optimize = false` - Disable optimizations to speed up compilation of stage1 rust
120+
- `optimize = false` - Disable optimizations to speed up compilation of stage1
121+
rust
120122

121123
For more options, the `config.toml` file contains commented out defaults, with
122124
descriptions of what each option will do.
@@ -264,7 +266,8 @@ guidelines by running
264266
$ python x.py test src/tools/tidy
265267

266268
Make this check before every pull request (and every new commit in a pull
267-
request) ; you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
269+
request) ; you can add
270+
[git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
268271
before every push to make sure you never forget to make this check.
269272

270273
All pull requests are reviewed by another person. We have a bot,
@@ -307,11 +310,11 @@ though you may see a slightly different form of `r+`:
307310

308311
@bors: r+ 38fe8d2 rollup
309312

310-
That additional `rollup` tells @bors that this change is eligible for a 'rollup'.
311-
To save @bors some work, and to get small changes through more quickly, when
312-
@bors attempts to merge a commit that's rollup-eligible, it will also merge
313-
the other rollup-eligible patches too, and they'll get tested and merged at
314-
the same time.
313+
That additional `rollup` tells @bors that this change is eligible for a
314+
'rollup'. To save @bors some work, and to get small changes through more
315+
quickly, when @bors attempts to merge a commit that's rollup-eligible, it will
316+
also merge the other rollup-eligible patches too, and they'll get tested and
317+
merged at the same time.
315318

316319
To find documentation-related issues, sort by the [A-docs label][adocs].
317320

@@ -394,12 +397,15 @@ are:
394397
* The [Rust Internals forum][rif], a place to ask questions and
395398
discuss Rust's internals
396399
* The [generated documentation for rust's compiler][gdfrustc]
397-
* The [rust reference][rr], even though it doesn't specifically talk about Rust's internals, it's a great resource nonetheless
400+
* The [rust reference][rr], even though it doesn't specifically talk about
401+
Rust's internals, it's a great resource nonetheless
398402
* Although out of date, [Tom Lee's great blog article][tlgba] is very helpful
399403
* [rustaceans.org][ro] is helpful, but mostly dedicated to IRC
400404
* The [Rust Compiler Testing Docs][rctd]
401-
* For @bors, [this cheat sheet][cheatsheet] is helpful (Remember to replace `@homu` with `@bors` in the commands that you use.)
402-
* **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly)
405+
* For @bors, [this cheat sheet][cheatsheet] is helpful (Remember to replace
406+
`@homu` with `@bors` in the commands that you use.)
407+
* **Google!** ([search only in Rust Documentation][gsearchdocs] to find types,
408+
traits, etc. quickly)
403409
* Don't be afraid to ask! The Rust community is friendly and helpful.
404410

405411
[gdfrustc]: http://manishearth.github.io/rust-internals-docs/rustc/

0 commit comments

Comments
 (0)