From a8b9990be738210299d8dfd35c585ccd40de1b09 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 02:45:22 +0200 Subject: [PATCH 01/20] separate link target from normal content --- src/contributing.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 6e81ce1f9..29dd0282b 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -16,8 +16,7 @@ please follow our [instructions for reporting security vulnerabilities][vuln]**. If you're using the nightly channel, please check if the bug exists in the latest toolchain before filing your bug. It might be fixed already. -If you have the chance, before reporting a bug, please [search existing -issues](https://github.com/rust-lang/rust/issues?q=is%3Aissue), +If you have the chance, before reporting a bug, please [search existing issues], as it's possible that someone else has already reported your error. This doesn't always work, and sometimes it's hard to know what to search for, so consider this extra credit. We won't mind if you accidentally file a duplicate report. @@ -473,3 +472,5 @@ This is used for [RFCs], issues, and pull requests. This section has moved to the ["About this guide"][more-links] chapter. [more-links]: ./about-this-guide.md#other-places-to-find-information + +[search existing issues]: https://github.com/rust-lang/rust/issues?q=is%3Aissue From 01041172f3be4356d775e5fd342b1d2a1d339953 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 02:49:31 +0200 Subject: [PATCH 02/20] avoid needless markdown linking noise --- src/contributing.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 29dd0282b..4c9cce33d 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -34,18 +34,18 @@ in the appropriate provided template. ## Bug Fixes or "Normal" code changes -For most PRs, no special procedures are needed. You can just [open a PR][prs], and it +For most PRs, no special procedures are needed. You can just [open a PR], and it will be reviewed, approved, and merged. This includes most bug fixes, refactorings, and other user-invisible changes. The next few sections talk about exceptions to this rule. -Also, note that it is perfectly acceptable to open WIP PRs or GitHub [Draft -PRs][draft]. Some people prefer to do this so they can get feedback along the +Also, note that it is perfectly acceptable to open WIP PRs or GitHub [Draft PRs]. +Some people prefer to do this so they can get feedback along the way or share their code with a collaborator. Others do this so they can utilize the CI to build and test their PR (e.g. if you are developing on a laptop). -[prs]: #pull-requests -[draft]: https://github.blog/2019-02-14-introducing-draft-pull-requests/ +[open a PR]: #pull-requests +[Draft PRs]: https://github.blog/2019-02-14-introducing-draft-pull-requests/ ## New Features From 2136d25b586fd679e54ba857afdf1082ead14360 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 02:50:23 +0200 Subject: [PATCH 03/20] generalise --- src/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/contributing.md b/src/contributing.md index 4c9cce33d..28e7d1e73 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -42,7 +42,7 @@ about exceptions to this rule. Also, note that it is perfectly acceptable to open WIP PRs or GitHub [Draft PRs]. Some people prefer to do this so they can get feedback along the way or share their code with a collaborator. Others do this so they can utilize -the CI to build and test their PR (e.g. if you are developing on a laptop). +the CI to build and test their PR (e.g. when developing on a slow machine). [open a PR]: #pull-requests [Draft PRs]: https://github.blog/2019-02-14-introducing-draft-pull-requests/ From 51071c58fdca3badd746617bf8aeecdc57fb7a2a Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 21:35:57 +0200 Subject: [PATCH 04/20] make sentence more simple, and account for moved info --- src/contributing.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 28e7d1e73..b17f55d72 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -174,13 +174,13 @@ Zulip ([#t-release/triage]). They have knowledge of when to ping, who might be on vacation, etc. The reviewer may request some changes using the GitHub code review interface. -They may also request special procedures (such as a [crater] run; [see -below][break]) for some PRs. +They may also request special procedures for some PRs. +See [Crater] and [Breaking Changes] chapters for some examples of such procedures. [r?]: https://github.com/rust-lang/rust/pull/78133#issuecomment-712692371 [#t-release/triage]: https://rust-lang.zulipchat.com/#narrow/stream/242269-t-release.2Ftriage -[break]: #breaking-changes -[crater]: tests/crater.md +[Breaking Changes]: bug-fix-procedure.md +[Crater]: tests/crater.md ### CI From 487bb7e3482ade43a4b7da9b68979556aa055ee6 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 21:37:49 +0200 Subject: [PATCH 05/20] share a link reference --- src/contributing.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index b17f55d72..a8571c8ce 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -64,9 +64,7 @@ information. ### Breaking Changes -Breaking changes have a [dedicated section][breaking-changes] in the dev-guide. - -[breaking-changes]: ./bug-fix-procedure.md +Breaking changes have a [dedicated section][Breaking Changes] in the dev-guide. ### Major Changes @@ -179,7 +177,6 @@ See [Crater] and [Breaking Changes] chapters for some examples of such procedure [r?]: https://github.com/rust-lang/rust/pull/78133#issuecomment-712692371 [#t-release/triage]: https://rust-lang.zulipchat.com/#narrow/stream/242269-t-release.2Ftriage -[Breaking Changes]: bug-fix-procedure.md [Crater]: tests/crater.md ### CI @@ -474,3 +471,4 @@ This section has moved to the ["About this guide"][more-links] chapter. [more-links]: ./about-this-guide.md#other-places-to-find-information [search existing issues]: https://github.com/rust-lang/rust/issues?q=is%3Aissue +[Breaking Changes]: bug-fix-procedure.md From 1cb196964803804c09ad647821d8392eaf905d25 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 21:40:22 +0200 Subject: [PATCH 06/20] avoid needless markdown linking noise (again) --- src/contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index a8571c8ce..0bba7a37f 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -77,12 +77,12 @@ Example of things that might require MCPs include major refactorings, changes to important types, or important changes to how the compiler does something, or smaller user-facing changes. -**When in doubt, ask on [zulip][z]. It would be a shame to put a lot of work +**When in doubt, ask on [zulip]. It would be a shame to put a lot of work into a PR that ends up not getting merged!** [See this document][mcpinfo] for more info on MCPs. [mcpinfo]: https://forge.rust-lang.org/compiler/mcp.html -[z]: https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler +[zulip]: https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler ### Performance From 7bd47cf060df719659f4dbb1d683eb7c0e9c7bca Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 21:43:03 +0200 Subject: [PATCH 07/20] make sentence more readable --- src/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/contributing.md b/src/contributing.md index 0bba7a37f..886e02c94 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -92,7 +92,7 @@ few years into [gradually improving it][perfdash]. [perfdash]: https://perf.rust-lang.org/dashboard.html If you suspect that your change may cause a performance regression (or -improvement), you can request a "perf run" (your reviewer may also request one +improvement), you can request a "perf run" (and your reviewer may also request one before approving). This is yet another bot that will compile a collection of benchmarks on a compiler with your changes. The numbers are reported [here][perf], and you can see a comparison of your changes against the latest From 991564ea92c59e4c3d110cc5107de569dd8773dc Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 21:46:58 +0200 Subject: [PATCH 08/20] feels like a sidenote --- src/contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 886e02c94..0fb7e2dfd 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -98,8 +98,8 @@ benchmarks on a compiler with your changes. The numbers are reported [here][perf], and you can see a comparison of your changes against the latest master. -For an introduction to the performance of Rust code in general -which would also be useful in rustc development, see [The Rust Performance Book]. +> For an introduction to the performance of Rust code in general +> which would also be useful in rustc development, see [The Rust Performance Book]. [perf]: https://perf.rust-lang.org [The Rust Performance Book]: https://nnethercote.github.io/perf-book/ From 70f1f5ebc8480f2470e7aa57ba7a910008e15325 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 21:50:35 +0200 Subject: [PATCH 09/20] improve wording a little --- src/contributing.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 0fb7e2dfd..48dbbca8d 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -132,8 +132,9 @@ to the end of the pull request description, and [@rustbot] will assign them instead of a random person. This is entirely optional. You can also assign a random reviewer from a specific team by writing `r? rust-lang/groupname`. -So if you were making a diagnostics change, then you could get a reviewer from the diagnostics -team by adding: +As an example, +if you were making a diagnostics change, +then you could get a reviewer from the diagnostics team by adding: r? rust-lang/diagnostics From 16caa0539464f7f6a83f3b4cf637df296908e7f3 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 21:52:00 +0200 Subject: [PATCH 10/20] missing pluralisation and comma --- src/contributing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/contributing.md b/src/contributing.md index 48dbbca8d..102580b3a 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -138,7 +138,8 @@ then you could get a reviewer from the diagnostics team by adding: r? rust-lang/diagnostics -For a full list of possible `groupname` check the `adhoc_groups` section at the +For a full list of possible `groupname`s, +check the `adhoc_groups` section at the [triagebot.toml config file](https://github.com/rust-lang/rust/blob/master/triagebot.toml) or the list of teams in the [rust-lang teams database](https://github.com/rust-lang/team/tree/master/teams). From cc3ba5c7c9d9ab52d6b342d8c68303c75dd57dcf Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 21:55:32 +0200 Subject: [PATCH 11/20] separate link target from normal content (again) --- src/contributing.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 102580b3a..85af05d75 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -139,10 +139,8 @@ then you could get a reviewer from the diagnostics team by adding: r? rust-lang/diagnostics For a full list of possible `groupname`s, -check the `adhoc_groups` section at the -[triagebot.toml config file](https://github.com/rust-lang/rust/blob/master/triagebot.toml) -or the list of teams in the [rust-lang teams -database](https://github.com/rust-lang/team/tree/master/teams). +check the `adhoc_groups` section at the [triagebot.toml config file], +or the list of teams in the [rust-lang teams database]. ### Waiting for reviews @@ -474,3 +472,5 @@ This section has moved to the ["About this guide"][more-links] chapter. [search existing issues]: https://github.com/rust-lang/rust/issues?q=is%3Aissue [Breaking Changes]: bug-fix-procedure.md +[triagebot.toml config file]: https://github.com/rust-lang/rust/blob/HEAD/triagebot.toml +[rust-lang teams database]: https://github.com/rust-lang/team/tree/HEAD/teams From 103da3ca057ee5ce1b9a32d3ebe21aef6a73fce5 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 21:57:50 +0200 Subject: [PATCH 12/20] missing comma --- src/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/contributing.md b/src/contributing.md index 85af05d75..f7ac3bb38 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -181,7 +181,7 @@ See [Crater] and [Breaking Changes] chapters for some examples of such procedure ### CI -In addition to being reviewed by a human, pull requests are automatically tested +In addition to being reviewed by a human, pull requests are automatically tested, thanks to continuous integration (CI). Basically, every time you open and update a pull request, CI builds the compiler and tests it against the [compiler test suite][rctd], and also performs other tests such as checking that From 3eaefbd4ea946247948ce42ff1a8f1cb16783c4d Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 22:03:17 +0200 Subject: [PATCH 13/20] avoid needless markdown linking noise (once more) --- src/contributing.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index f7ac3bb38..5b2833b63 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -184,11 +184,9 @@ See [Crater] and [Breaking Changes] chapters for some examples of such procedure In addition to being reviewed by a human, pull requests are automatically tested, thanks to continuous integration (CI). Basically, every time you open and update a pull request, CI builds the compiler and tests it against the -[compiler test suite][rctd], and also performs other tests such as checking that +[compiler test suite], and also performs other tests such as checking that your pull request is in compliance with Rust's style guidelines. -[rctd]: tests/intro.md - Running continuous integration tests allows PR authors to catch mistakes early without going through a first review cycle, and also helps reviewers stay aware of the status of a particular pull request. @@ -207,7 +205,7 @@ on the pull request with an `r+`. It will look something like this: @bors r+ This tells [@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], 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. @@ -224,7 +222,6 @@ Be patient; this can take a while and the queue can sometimes be long. PRs are n [@rustbot]: https://github.com/rustbot [@bors]: https://github.com/bors -[merge-queue]: https://bors.rust-lang.org/queue/rust ### Opening a PR @@ -474,3 +471,5 @@ This section has moved to the ["About this guide"][more-links] chapter. [Breaking Changes]: bug-fix-procedure.md [triagebot.toml config file]: https://github.com/rust-lang/rust/blob/HEAD/triagebot.toml [rust-lang teams database]: https://github.com/rust-lang/team/tree/HEAD/teams +[compiler test suite]: tests/intro.md +[merge queue]: https://bors.rust-lang.org/queue/rust From 41eee42b3c3a191e440d28b922fc33650fee6106 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 22:07:39 +0200 Subject: [PATCH 14/20] avoid repetition --- src/contributing.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 5b2833b63..beff29eef 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -228,9 +228,8 @@ Be patient; this can take a while and the queue can sometimes be long. PRs are n You are now ready to file a pull request? Great! Here are a few points you should be aware of. -All pull requests should be filed against the `master` branch, except in very -particular scenarios. Unless you know for sure that you should target another -branch, `master` will be the right choice (it's also the default). +All pull requests should be filed against the `master` branch, +unless you know for sure that you should target a different branch. Make sure your pull request is in compliance with Rust's style guidelines by running From b523eafecbd30c63fcf7b06c34254eae622cd8b4 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 22:09:10 +0200 Subject: [PATCH 15/20] separate link target from normal content (once more) --- src/contributing.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/contributing.md b/src/contributing.md index beff29eef..740070105 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -236,7 +236,7 @@ Make sure your pull request is in compliance with Rust's style guidelines by run $ ./x test tidy --bless We recommend to make this check before every pull request (and every new commit -in a pull request); you can add [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) +in a pull request); you can add [git hooks] before every push to make sure you never forget to make this check. The CI will also run tidy and will fail if tidy fails. @@ -472,3 +472,4 @@ This section has moved to the ["About this guide"][more-links] chapter. [rust-lang teams database]: https://github.com/rust-lang/team/tree/HEAD/teams [compiler test suite]: tests/intro.md [merge queue]: https://bors.rust-lang.org/queue/rust +[git hooks]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks From 4966e991fb9fb195f18aa2734d354f7eb56d59e7 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 22:10:12 +0200 Subject: [PATCH 16/20] semantic line breaks --- src/contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 740070105..c9b7e64ab 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -237,8 +237,8 @@ Make sure your pull request is in compliance with Rust's style guidelines by run We recommend to make this check before every pull request (and every new commit in a pull request); you can add [git hooks] -before every push to make sure you never forget to make this check. The -CI will also run tidy and will fail if tidy fails. +before every push to make sure you never forget to make this check. +The CI will also run tidy and will fail if tidy fails. Rust follows a _no merge-commit policy_, meaning, when you encounter merge conflicts you are expected to always rebase instead of merging. E.g. always use From b855ac09d1f464e556b07cd83aa398caf3a8d5a1 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 22:17:41 +0200 Subject: [PATCH 17/20] avoid needless markdown linking noise (yet again) Also, follow semantic line breaks. --- src/contributing.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index c9b7e64ab..e93043003 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -276,13 +276,9 @@ function in the same way as other pull requests. [`src/doc`]: https://github.com/rust-lang/rust/tree/master/src/doc [std-root]: https://github.com/rust-lang/rust/blob/master/library/std/src/lib.rs#L1 -To find documentation-related issues, sort by the [A-docs label][adocs]. +To find documentation-related issues, sort by the [A-docs label]. -[adocs]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AA-docs - -You can find documentation style guidelines in [RFC 1574][rfc1574]. - -[rfc1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text +You can find documentation style guidelines in [RFC 1574]. To build the standard library documentation, use `x doc --stage 0 library --open`. To build the documentation for a book (e.g. the unstable book), use `x doc src/doc/unstable-book.` @@ -296,22 +292,23 @@ The CSS might be messed up, but you can verify that the HTML is right. ### Contributing to rustc-dev-guide -Contributions to the [rustc-dev-guide][rdg] are always welcome, and can be made directly at +Contributions to the [rustc-dev-guide] are always welcome, and can be made directly at [the rust-lang/rustc-dev-guide repo][rdgrepo]. The issue tracker in that repo is also a great way to find things that need doing. There are issues for beginners and advanced compiler devs alike! Just a few things to keep in mind: -- Please limit line length to 100 characters. This is enforced by CI, and you can run the checks - locally with `ci/lengthcheck.sh`. +- Please limit line length to 100 characters. + This is enforced by CI, + and you can run the checks locally with `ci/lengthcheck.sh`. - When contributing text to the guide, please contextualize the information with some time period and/or a reason so that the reader knows how much to trust or mistrust the information. Aim to provide a reasonable amount of context, possibly including but not limited to: - - A reason for why the data may be out of date other than "change", as change is a constant across - the project. + - A reason for why the data may be out of date other than "change", + as change is a constant across the project. - The date the comment was added, e.g. instead of writing _"Currently, ..."_ or _"As of now, ..."_, @@ -352,9 +349,6 @@ Just a few things to keep in mind: subsections) it might benefit from having a Table of Contents at the beginning, which you can auto-generate by including the `` marker. -[rdg]: https://rustc-dev-guide.rust-lang.org/ -[rdgrepo]: https://github.com/rust-lang/rustc-dev-guide - ## Issue Triage Sometimes, an issue will stay open, even though the bug has been fixed. And @@ -473,3 +467,7 @@ This section has moved to the ["About this guide"][more-links] chapter. [compiler test suite]: tests/intro.md [merge queue]: https://bors.rust-lang.org/queue/rust [git hooks]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks +[A-docs label]: https://github.com/rust-lang/rust/issues?q=is%3Aopen%20is%3Aissue%20label%3AA-docs +[RFC 1574]: https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text +[rustc-dev-guide]: https://rustc-dev-guide.rust-lang.org/ +[rdgrepo]: https://github.com/rust-lang/rustc-dev-guide From 573c0b977addc7a7311976ff9bfe627eda61af0b Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 22:28:02 +0200 Subject: [PATCH 18/20] semantic line breaks --- src/contributing.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index e93043003..32367c49e 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -351,14 +351,13 @@ Just a few things to keep in mind: ## Issue Triage -Sometimes, an issue will stay open, even though the bug has been fixed. And -sometimes, the original bug may go stale because something has changed in the -meantime. - -It can be helpful to go through older bug reports and make sure that they are -still valid. Load up an older issue, double check that it's still true, and -leave a comment letting us know if it is or is not. The [least recently -updated sort][lru] is good for finding issues like this. +Sometimes, an issue will stay open, even though the bug has been fixed. +And sometimes, the original bug may go stale because something has changed in the meantime. + +It can be helpful to go through older bug reports and make sure that they are still valid. +Load up an older issue, double check that it's still true, +and leave a comment letting us know if it is or is not. +The [least recently updated sort][lru] is good for finding issues like this. [Thanks to `@rustbot`][rustbot], anyone can help triage issues by adding appropriate labels to issues that haven't been triaged yet: From 2d0f66d6a21c27729b129dfa2d96b995a1bc858d Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 22:33:30 +0200 Subject: [PATCH 19/20] avoid title case --- src/contributing.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 32367c49e..346e079fc 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -2,7 +2,7 @@ -## Bug Reports +## Bug reports While bugs are unfortunate, they're a reality in software. We can't fix what we don't know about, so please report liberally. If you're not sure if something @@ -32,7 +32,7 @@ Opening an issue is as easy as following [this link](https://github.com/rust-lang/rust/issues/new/choose) and filling out the fields in the appropriate provided template. -## Bug Fixes or "Normal" code changes +## Bug fixes or "normal" code changes For most PRs, no special procedures are needed. You can just [open a PR], and it will be reviewed, approved, and merged. This includes most bug fixes, @@ -47,7 +47,7 @@ the CI to build and test their PR (e.g. when developing on a slow machine). [open a PR]: #pull-requests [Draft PRs]: https://github.blog/2019-02-14-introducing-draft-pull-requests/ -## New Features +## New features Rust has strong backwards-compatibility guarantees. Thus, new features can't just be implemented directly in stable Rust. Instead, we have 3 release @@ -62,11 +62,11 @@ channels: stable, beta, and nightly. See [this chapter on implementing new features](./implementing_new_features.md) for more information. -### Breaking Changes +### Breaking changes Breaking changes have a [dedicated section][Breaking Changes] in the dev-guide. -### Major Changes +### Major changes The compiler team has a special process for large changes, whether or not they cause breakage. This process is called a Major Change Proposal (MCP). MCP is a @@ -104,7 +104,7 @@ master. [perf]: https://perf.rust-lang.org [The Rust Performance Book]: https://nnethercote.github.io/perf-book/ -## Pull Requests +## Pull requests Pull requests (or PRs for short) are the primary mechanism we use to change Rust. GitHub itself has some [great documentation][about-pull-requests] on using the @@ -262,11 +262,11 @@ the issue in question. [labeling]: ./rustbot.md#issue-relabeling [closing-keywords]: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue -## External Dependencies +## External dependencies This section has moved to ["Using External Repositories"](./external-repos.md). -## Writing Documentation +## Writing documentation 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 @@ -349,7 +349,7 @@ Just a few things to keep in mind: subsections) it might benefit from having a Table of Contents at the beginning, which you can auto-generate by including the `` marker. -## Issue Triage +## Issue triage Sometimes, an issue will stay open, even though the bug has been fixed. And sometimes, the original bug may go stale because something has changed in the meantime. @@ -453,7 +453,7 @@ This is used for [RFCs], issues, and pull requests. [rfcbot]: https://github.com/anp/rfcbot-rs/ [RFCs]: https://github.com/rust-lang/rfcs -## Helpful Links and Information +## Helpful links and information This section has moved to the ["About this guide"][more-links] chapter. From bbf31db5d491602a2405a7208d7943d920aa67de Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 5 Jul 2023 22:36:13 +0200 Subject: [PATCH 20/20] avoid needless markdown linking noise (last time this time) --- src/contributing.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/contributing.md b/src/contributing.md index 346e079fc..d6b9fc84d 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -455,10 +455,9 @@ This is used for [RFCs], issues, and pull requests. ## Helpful links and information -This section has moved to the ["About this guide"][more-links] chapter. - -[more-links]: ./about-this-guide.md#other-places-to-find-information +This section has moved to the ["About this guide"] chapter. +["About this guide"]: about-this-guide.md#other-places-to-find-information [search existing issues]: https://github.com/rust-lang/rust/issues?q=is%3Aissue [Breaking Changes]: bug-fix-procedure.md [triagebot.toml config file]: https://github.com/rust-lang/rust/blob/HEAD/triagebot.toml