44
55While bugs are unfortunate, they're a reality in software.
66We can't fix what we don't know about, so please report liberally.
7- If you're not sure if something is a bug or not , feel free to file a bug anyway.
7+ If you're not sure if something is a bug, feel free to open an issue anyway.
88
99** If you believe reporting your bug publicly represents a security risk to Rust users,
1010please follow our [ instructions for reporting security vulnerabilities] [ vuln ] ** .
@@ -77,12 +77,12 @@ Example of things that might require MCPs include major refactorings, changes
7777to important types, or important changes to how the compiler does something, or
7878smaller user-facing changes.
7979
80- ** When in doubt, ask on [ Zulip] .
80+ ** When in doubt, ask [ on Zulip] .
8181It would be a shame to put a lot of work
8282into a PR that ends up not getting merged!** [ See this document] [ mcpinfo ] for more info on MCPs.
8383
8484[ mcpinfo ] : https://forge.rust-lang.org/compiler/proposals-and-stabilization.html#how-do-i-submit-an-mcp
85- [ zulip ] : https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler
85+ [ on Zulip ] : https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler
8686
8787### Performance
8888
@@ -109,10 +109,10 @@ The numbers are reported
109109
110110Pull requests (or PRs for short) are the primary mechanism we use to change Rust.
111111GitHub itself has some [ great documentation] [ about-pull-requests ] on using the Pull Request feature.
112- We use the "fork and pull" model [ described here ] [ development-models ] ,
112+ We use the [ "fork and pull" model] [ development-models ] ,
113113where contributors push changes to their personal fork and create pull requests to
114114bring those changes into the source repository.
115- We have more info about how to use git when contributing to Rust under [ the git section ] ( ./git.md ) .
115+ We have [ a chapter ] ( git.md ) on how to use Git when contributing to Rust.
116116
117117> ** Advice for potentially large, complex, cross-cutting and/or very domain-specific changes**
118118>
@@ -178,22 +178,19 @@ to review your request based on which files you changed.
178178
179179If you want to request that a specific person reviews your pull request, you
180180can add an ` r? ` to the pull request description or in a comment.
181- For example, if you want to ask a review to @awesome-reviewer , add
181+ For example, if you want to ask a review by @awesome-reviewer ,
182+ add the following to the end of the pull request description:
182183
183- r?
184- @awesome-reviewer
184+ r? @awesome-reviewer
185185
186- to the end of the pull request description, and [ @rustbot ] will assign
187- them instead of a random person.
186+ [ @rustbot ] will then assign the PR to that reviewer instead of a random person.
188187This is entirely optional.
189188
190- You can also assign a random reviewer from a specific team by writing `r?
191- rust-lang/groupname`.
189+ You can also assign a random reviewer from a specific team by writing ` r? rust-lang/groupname ` .
192190As an example, if you were making a diagnostics change,
193- then you could get a reviewer from the diagnostics team by adding:
191+ you could get a reviewer from the diagnostics team by adding:
194192
195- r?
196- rust-lang/diagnostics
193+ r? rust-lang/diagnostics
197194
198195For a full list of possible ` groupname ` s,
199196check the ` adhoc_groups ` section at the [ triagebot.toml config file] ,
@@ -275,12 +272,12 @@ Depending on the scale of the change, you may see a slightly different form of `
275272
276273The additional ` rollup ` tells [ @bors ] that this change should always be "rolled up".
277274Changes that are rolled up are tested and merged alongside other PRs, to speed the process up.
278- Typically only small changes that are expected not to conflict
275+ Typically, only small changes that are expected not to conflict
279276with one another are marked as "always roll up".
280277
281278Be patient;
282279this can take a while and the queue can sometimes be long.
283- PRs are never merged by hand.
280+ Also, note that PRs are never merged by hand.
284281
285282[ @rustbot ] : https://github.com/rustbot
286283[ @bors ] : https://github.com/bors
@@ -302,11 +299,11 @@ We recommend to make this check before every pull request (and every new commit
302299you can add [ git hooks] before every push to make sure you never forget to make this check.
303300The CI will also run tidy and will fail if tidy fails.
304301
305- Rust follows a _ no merge-commit policy_ , meaning, when you encounter merge
306- conflicts you are expected to always rebase instead of merging.
307- E.g .
308- always use rebase when bringing the latest changes from the master branch to your feature
309- branch.
302+ Rust follows a _ no merge-commit policy_ ,
303+ meaning that when you encounter merge conflicts,
304+ you are expected to always rebase instead of merging .
305+ For example,
306+ always use rebase when bringing the latest changes from the master branch to your feature branch.
310307If your PR contains merge commits, it will get marked as ` has-merge-commits ` .
311308Once you have removed the merge commits, e.g., through an interactive rebase, you
312309should remove the label again:
@@ -424,7 +421,7 @@ Just a few things to keep in mind:
424421 and/or a reason so that the reader knows how much to trust the information.
425422 Aim to provide a reasonable amount of context, possibly including but not limited to:
426423
427- - A reason for why the data may be out of date other than "change",
424+ - A reason for why the text may be out of date other than "change",
428425 as change is a constant across the project.
429426
430427 - The date the comment was added, e.g. instead of writing _ "Currently, ..."_
0 commit comments