Skip to content

Commit 46cae3e

Browse files
authored
Rollup merge of rust-lang#59172 - varkor:contributing-contributions, r=steveklabnik
Update and clean up several parts of CONTRIBUTING.md
2 parents 0612ad0 + 037596c commit 46cae3e

File tree

1 file changed

+29
-23
lines changed

1 file changed

+29
-23
lines changed

CONTRIBUTING.md

+29-23
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ links to the major sections:
1515
* [Helpful Links and Information](#helpful-links-and-information)
1616

1717
If you have questions, please make a post on [internals.rust-lang.org][internals] or
18-
hop on [#rust-internals][pound-rust-internals].
18+
hop on the [Rust Discord server][rust-discord], [Rust Zulip server][rust-zulip] or [#rust-internals][pound-rust-internals].
1919

2020
As a reminder, all contributors are expected to follow our [Code of Conduct][coc].
2121

@@ -27,14 +27,17 @@ can give you a good example of how a typical contribution would go.
2727

2828
[pound-rust-internals]: https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals
2929
[internals]: https://internals.rust-lang.org
30+
[rust-discord]: http://discord.gg/rust-lang
31+
[rust-zulip]: https://rust-lang.zulipchat.com
3032
[coc]: https://www.rust-lang.org/conduct.html
33+
[rustc-guide]: https://rust-lang.github.io/rustc-guide/
3134
[walkthrough]: https://rust-lang.github.io/rustc-guide/walkthrough.html
3235

3336
## Feature Requests
3437
[feature-requests]: #feature-requests
3538

3639
To request a change to the way the Rust language works, please head over
37-
to the [RFCs repository](https://github.com/rust-lang/rfcs) and view the
40+
to the [RFCs repository](https://github.com/rust-lang/rfcs) and view the
3841
[README](https://github.com/rust-lang/rfcs/blob/master/README.md)
3942
for instructions.
4043

@@ -129,28 +132,40 @@ request); you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git
129132
before every push to make sure you never forget to make this check.
130133

131134
All pull requests are reviewed by another person. We have a bot,
132-
@rust-highfive, that will automatically assign a random person to review your
135+
[@rust-highfive][rust-highfive], that will automatically assign a random person to review your
133136
request.
134137

135138
If you want to request that a specific person reviews your pull request,
136-
you can add an `r?` to the message. For example, Steve usually reviews
139+
you can add an `r?` to the message. For example, [Steve][steveklabnik] usually reviews
137140
documentation changes. So if you were to make a documentation change, add
138141

139142
r? @steveklabnik
140143

141-
to the end of the message, and @rust-highfive will assign @steveklabnik instead
144+
to the end of the message, and @rust-highfive will assign [@steveklabnik][steveklabnik] instead
142145
of a random person. This is entirely optional.
143146

144147
After someone has reviewed your pull request, they will leave an annotation
145148
on the pull request with an `r+`. It will look something like this:
146149

147-
@bors: r+ 38fe8d2
150+
@bors r+
148151

149-
This tells @bors, our lovable integration bot, that your pull request has
150-
been approved. The PR then enters the [merge queue][merge-queue], where @bors
152+
This tells [@bors][bors], our lovable integration bot, that your pull request has
153+
been approved. The PR then enters the [merge queue][merge-queue], where [@bors][bors]
151154
will run all the tests on every platform we support. If it all works out,
152-
@bors will merge your code into `master` and close the pull request.
155+
[@bors][bors] will merge your code into `master` and close the pull request.
153156

157+
Depending on the scale of the change, you may see a slightly different form of `r+`:
158+
159+
@bors r+ rollup
160+
161+
The additional `rollup` tells [@bors][bors] that this change is eligible for to be
162+
"rolled up". Changes that are rolled up are tested and merged at the same time, to
163+
speed the process up. Typically only small changes that are expected not to conflict
164+
with one another are rolled up.
165+
166+
[rust-highfive]: https://github.com/rust-highfive
167+
[steveklabnik]: https://github.com/steveklabnik
168+
[bors]: https://github.com/bors
154169
[merge-queue]: https://buildbot2.rust-lang.org/homu/queue/rust
155170

156171
Speaking of tests, Rust has a comprehensive test suite. More information about
@@ -190,7 +205,7 @@ before the PR is merged.
190205
[breaking-tools-built-with-the-compiler]: #breaking-tools-built-with-the-compiler
191206

192207
Rust's build system builds a number of tools that make use of the
193-
internals of the compiler. This includes
208+
internals of the compiler. This includes
194209
[Clippy](https://github.com/rust-lang/rust-clippy),
195210
[RLS](https://github.com/rust-lang/rls) and
196211
[rustfmt](https://github.com/rust-lang/rustfmt). If these tools
@@ -292,18 +307,8 @@ the submodule to. Running `./x.py build` should work now.
292307

293308
Documentation improvements are very welcome. The source of `doc.rust-lang.org`
294309
is located in `src/doc` in the tree, and standard API documentation is generated
295-
from the source code itself.
296-
297-
Documentation pull requests function in the same way as other pull requests,
298-
though you may see a slightly different form of `r+`:
299-
300-
@bors: r+ 38fe8d2 rollup
301-
302-
That additional `rollup` tells @bors that this change is eligible for a 'rollup'.
303-
To save @bors some work, and to get small changes through more quickly, when
304-
@bors attempts to merge a commit that's rollup-eligible, it will also merge
305-
the other rollup-eligible patches too, and they'll get tested and merged at
306-
the same time.
310+
from the source code itself. Documentation pull requests function in the same way
311+
as other pull requests.
307312

308313
To find documentation-related issues, sort by the [T-doc label][tdoc].
309314

@@ -428,7 +433,8 @@ are:
428433
* Although out of date, [Tom Lee's great blog article][tlgba] is very helpful
429434
* [rustaceans.org][ro] is helpful, but mostly dedicated to IRC
430435
* The [Rust Compiler Testing Docs][rctd]
431-
* For @bors, [this cheat sheet][cheatsheet] is helpful (Remember to replace `@homu` with `@bors` in the commands that you use.)
436+
* For [@bors][bors], [this cheat sheet][cheatsheet] is helpful
437+
(though you'll need to replace `@homu` with `@bors` in any commands)
432438
* **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly)
433439
* Don't be afraid to ask! The Rust community is friendly and helpful.
434440

0 commit comments

Comments
 (0)