From ff5e31ffb5224f458711a35392e0acddb1d4080a Mon Sep 17 00:00:00 2001 From: varkor Date: Thu, 14 Mar 2019 01:02:56 +0000 Subject: [PATCH 1/8] Fix a broken link to the rustc-guide --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e785f03d7de2b..1fc942c7cd98a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,6 +28,7 @@ can give you a good example of how a typical contribution would go. [pound-rust-internals]: https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals [internals]: https://internals.rust-lang.org [coc]: https://www.rust-lang.org/conduct.html +[rustc-guide]: https://rust-lang.github.io/rustc-guide/ [walkthrough]: https://rust-lang.github.io/rustc-guide/walkthrough.html ## Feature Requests From 6e449daceacd5959b830d24a8c9fc9971a2fc8ea Mon Sep 17 00:00:00 2001 From: varkor Date: Thu, 14 Mar 2019 01:03:11 +0000 Subject: [PATCH 2/8] Remove trailing newlines --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fc942c7cd98a..02777621d6571 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,7 @@ can give you a good example of how a typical contribution would go. [feature-requests]: #feature-requests To request a change to the way the Rust language works, please head over -to the [RFCs repository](https://github.com/rust-lang/rfcs) and view the +to the [RFCs repository](https://github.com/rust-lang/rfcs) and view the [README](https://github.com/rust-lang/rfcs/blob/master/README.md) for instructions. @@ -191,7 +191,7 @@ before the PR is merged. [breaking-tools-built-with-the-compiler]: #breaking-tools-built-with-the-compiler Rust's build system builds a number of tools that make use of the -internals of the compiler. This includes +internals of the compiler. This includes [Clippy](https://github.com/rust-lang/rust-clippy), [RLS](https://github.com/rust-lang/rls) and [rustfmt](https://github.com/rust-lang/rustfmt). If these tools From 205ab0c260e983615de3a2ed71c8e82e5c48dd8d Mon Sep 17 00:00:00 2001 From: varkor Date: Thu, 14 Mar 2019 01:04:19 +0000 Subject: [PATCH 3/8] Add a link to the Discord and Zulip servers --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 02777621d6571..35a741babd23f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ links to the major sections: * [Helpful Links and Information](#helpful-links-and-information) If you have questions, please make a post on [internals.rust-lang.org][internals] or -hop on [#rust-internals][pound-rust-internals]. +hop on the [Rust Discord server][rust-discord], [Rust Zulip server][rust-zulip] or [#rust-internals][pound-rust-internals]. As a reminder, all contributors are expected to follow our [Code of Conduct][coc]. @@ -27,6 +27,8 @@ can give you a good example of how a typical contribution would go. [pound-rust-internals]: https://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals [internals]: https://internals.rust-lang.org +[rust-discord]: http://discord.gg/rust-lang +[rust-zulip]: https://rust-lang.zulipchat.com [coc]: https://www.rust-lang.org/conduct.html [rustc-guide]: https://rust-lang.github.io/rustc-guide/ [walkthrough]: https://rust-lang.github.io/rustc-guide/walkthrough.html From 6f3fda9d1d603084c8e6a323bdbea7b780ba87ca Mon Sep 17 00:00:00 2001 From: varkor Date: Thu, 14 Mar 2019 01:07:00 +0000 Subject: [PATCH 4/8] Add links to @rust-highfive and @bors --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35a741babd23f..dde4ac3bbeb77 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -132,7 +132,7 @@ request); you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git before every push to make sure you never forget to make this check. All pull requests are reviewed by another person. We have a bot, -@rust-highfive, that will automatically assign a random person to review your +[@rust-highfive][rust-highfive], that will automatically assign a random person to review your request. If you want to request that a specific person reviews your pull request, @@ -149,11 +149,13 @@ on the pull request with an `r+`. It will look something like this: @bors: r+ 38fe8d2 -This tells @bors, our lovable integration bot, that your pull request has +This tells [@bors][bors], our lovable integration bot, that your pull request has been approved. The PR then enters the [merge queue][merge-queue], where @bors will run all the tests on every platform we support. If it all works out, @bors will merge your code into `master` and close the pull request. +[rust-highfive]: https://github.com/rust-highfive +[bors]: https://github.com/bors [merge-queue]: https://buildbot2.rust-lang.org/homu/queue/rust Speaking of tests, Rust has a comprehensive test suite. More information about From eadb8443f3ea4269b7010afa3bd5de21515c23b1 Mon Sep 17 00:00:00 2001 From: varkor Date: Thu, 14 Mar 2019 01:09:32 +0000 Subject: [PATCH 5/8] Update r+ syntax --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dde4ac3bbeb77..5276171728f0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -147,7 +147,7 @@ of a random person. This is entirely optional. After someone has reviewed your pull request, they will leave an annotation on the pull request with an `r+`. It will look something like this: - @bors: r+ 38fe8d2 + @bors r+ This tells [@bors][bors], our lovable integration bot, that your pull request has been approved. The PR then enters the [merge queue][merge-queue], where @bors @@ -302,7 +302,7 @@ from the source code itself. Documentation pull requests function in the same way as other pull requests, though you may see a slightly different form of `r+`: - @bors: r+ 38fe8d2 rollup + @bors r+ rollup That additional `rollup` tells @bors that this change is eligible for a 'rollup'. To save @bors some work, and to get small changes through more quickly, when From 308a002eb16425b5164c1d2931d26d802ae89f6f Mon Sep 17 00:00:00 2001 From: varkor Date: Thu, 14 Mar 2019 01:13:26 +0000 Subject: [PATCH 6/8] Make all references to @bors or users links --- CONTRIBUTING.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5276171728f0e..d6253dcb2338a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -136,12 +136,12 @@ All pull requests are reviewed by another person. We have a bot, request. If you want to request that a specific person reviews your pull request, -you can add an `r?` to the message. For example, Steve usually reviews +you can add an `r?` to the message. For example, [Steve][steveklabnik] usually reviews documentation changes. So if you were to make a documentation change, add r? @steveklabnik -to the end of the message, and @rust-highfive will assign @steveklabnik instead +to the end of the message, and @rust-highfive will assign [@steveklabnik][steveklabnik] instead of a random person. This is entirely optional. After someone has reviewed your pull request, they will leave an annotation @@ -150,11 +150,12 @@ on the pull request with an `r+`. It will look something like this: @bors r+ This tells [@bors][bors], our lovable integration bot, that your pull request has -been approved. The PR then enters the [merge queue][merge-queue], where @bors +been approved. The PR then enters the [merge queue][merge-queue], where [@bors][bors] will run all the tests on every platform we support. If it all works out, -@bors will merge your code into `master` and close the pull request. +[@bors][bors] will merge your code into `master` and close the pull request. [rust-highfive]: https://github.com/rust-highfive +[steveklabnik]: https://github.com/steveklabnik [bors]: https://github.com/bors [merge-queue]: https://buildbot2.rust-lang.org/homu/queue/rust @@ -304,9 +305,9 @@ though you may see a slightly different form of `r+`: @bors r+ rollup -That additional `rollup` tells @bors that this change is eligible for a 'rollup'. -To save @bors some work, and to get small changes through more quickly, when -@bors attempts to merge a commit that's rollup-eligible, it will also merge +That additional `rollup` tells [@bors][bors] that this change is eligible for a 'rollup'. +To save [@bors][bors] some work, and to get small changes through more quickly, when +[@bors][bors] attempts to merge a commit that's rollup-eligible, it will also merge the other rollup-eligible patches too, and they'll get tested and merged at the same time. @@ -433,7 +434,7 @@ are: * Although out of date, [Tom Lee's great blog article][tlgba] is very helpful * [rustaceans.org][ro] is helpful, but mostly dedicated to IRC * The [Rust Compiler Testing Docs][rctd] -* For @bors, [this cheat sheet][cheatsheet] is helpful (Remember to replace `@homu` with `@bors` in the commands that you use.) +* For [@bors][bors], [this cheat sheet][cheatsheet] is helpful (Remember to replace `@homu` with `@bors` in the commands that you use.) * **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly) * Don't be afraid to ask! The Rust community is friendly and helpful. From 3a00649256c64cacfdbf5f0e7b370d660291d06e Mon Sep 17 00:00:00 2001 From: varkor Date: Thu, 14 Mar 2019 01:17:49 +0000 Subject: [PATCH 7/8] Move rollup description earlier --- CONTRIBUTING.md | 23 +++++++++++------------ 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d6253dcb2338a..ee56f5bf9954e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -154,6 +154,15 @@ been approved. The PR then enters the [merge queue][merge-queue], where [@bors][ will run all the tests on every platform we support. If it all works out, [@bors][bors] will merge your code into `master` and close the pull request. +Depending on the scale of the change, you may see a slightly different form of `r+`: + + @bors r+ rollup + +The additional `rollup` tells [@bors][bors] that this change is eligible for to be +"rolled up". Changes that are rolled up are tested and merged at the same time, to +speed the process up. Typically only small changes that are expected not to conflict +with one another are rolled up. + [rust-highfive]: https://github.com/rust-highfive [steveklabnik]: https://github.com/steveklabnik [bors]: https://github.com/bors @@ -298,18 +307,8 @@ the submodule to. Running `./x.py build` should work now. Documentation improvements are very welcome. The source of `doc.rust-lang.org` is located in `src/doc` in the tree, and standard API documentation is generated -from the source code itself. - -Documentation pull requests function in the same way as other pull requests, -though you may see a slightly different form of `r+`: - - @bors r+ rollup - -That additional `rollup` tells [@bors][bors] that this change is eligible for a 'rollup'. -To save [@bors][bors] some work, and to get small changes through more quickly, when -[@bors][bors] attempts to merge a commit that's rollup-eligible, it will also merge -the other rollup-eligible patches too, and they'll get tested and merged at -the same time. +from the source code itself. Documentation pull requests function in the same way +as other pull requests. To find documentation-related issues, sort by the [T-doc label][tdoc]. From 037596c4ce1548543479ace50500ee3dc2f6720e Mon Sep 17 00:00:00 2001 From: varkor Date: Thu, 14 Mar 2019 01:20:41 +0000 Subject: [PATCH 8/8] Fix capitalisation problem --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ee56f5bf9954e..fa408935cc8cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -433,7 +433,8 @@ are: * Although out of date, [Tom Lee's great blog article][tlgba] is very helpful * [rustaceans.org][ro] is helpful, but mostly dedicated to IRC * The [Rust Compiler Testing Docs][rctd] -* For [@bors][bors], [this cheat sheet][cheatsheet] is helpful (Remember to replace `@homu` with `@bors` in the commands that you use.) +* For [@bors][bors], [this cheat sheet][cheatsheet] is helpful +(though you'll need to replace `@homu` with `@bors` in any commands) * **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly) * Don't be afraid to ask! The Rust community is friendly and helpful.