Skip to content

Commit d1148d8

Browse files
committed
sembr README.md
1 parent a9e1f24 commit d1148d8

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[![CI](https://github.com/rust-lang/rustc-dev-guide/actions/workflows/ci.yml/badge.svg)](https://github.com/rust-lang/rustc-dev-guide/actions/workflows/ci.yml)
22

33

4-
This is a collaborative effort to build a guide that explains how rustc
5-
works. The aim of the guide is to help new contributors get oriented
4+
This is a collaborative effort to build a guide that explains how rustc works.
5+
The aim of the guide is to help new contributors get oriented
66
to rustc, as well as to help more experienced folks in figuring out
77
some new part of the compiler that they haven't worked on before.
88

@@ -21,25 +21,24 @@ For documentation on developing the standard library, see
2121

2222
The guide is useful today, but it has a lot of work still to go.
2323

24-
If you'd like to help improve the guide, we'd love to have you! You can find
25-
plenty of issues on the [issue
26-
tracker](https://github.com/rust-lang/rustc-dev-guide/issues). Just post a
27-
comment on the issue you would like to work on to make sure that we don't
28-
accidentally duplicate work. If you think something is missing, please open an
29-
issue about it!
24+
If you'd like to help improve the guide, we'd love to have you!
25+
You can find plenty of issues on the [issue
26+
tracker](https://github.com/rust-lang/rustc-dev-guide/issues).
27+
Just post a comment on the issue you would like to work on to make sure that we don't
28+
accidentally duplicate work.
29+
If you think something is missing, please open an issue about it!
3030

3131
**In general, if you don't know how the compiler works, that is not a
3232
problem!** In that case, what we will do is to schedule a bit of time
3333
for you to talk with someone who **does** know the code, or who wants
34-
to pair with you and figure it out. Then you can work on writing up
35-
what you learned.
34+
to pair with you and figure it out.
35+
Then you can work on writing up what you learned.
3636

3737
In general, when writing about a particular part of the compiler's code, we
38-
recommend that you link to the relevant parts of the [rustc
39-
rustdocs][rustdocs].
38+
recommend that you link to the relevant parts of the [rustc rustdocs][rustdocs].
4039

41-
The guide has a much lower bar for what it takes for a PR to be merged. Check out
42-
the forge documentation for [our policy][forge_policy].
40+
The guide has a much lower bar for what it takes for a PR to be merged.
41+
Check out the forge documentation for [our policy][forge_policy].
4342

4443
[forge_policy]: https://forge.rust-lang.org/rustc-dev-guide/index.html#review-policy
4544

@@ -61,9 +60,9 @@ The build files are found in the `book/html` directory.
6160

6261
### Link Validations
6362

64-
We use `mdbook-linkcheck2` to validate URLs included in our documentation. Link
65-
checking is **not** run by default locally, though it is in CI. To enable it
66-
locally, set the environment variable `ENABLE_LINKCHECK=1` like in the
63+
We use `mdbook-linkcheck2` to validate URLs included in our documentation.
64+
Link checking is **not** run by default locally, though it is in CI.
65+
To enable it locally, set the environment variable `ENABLE_LINKCHECK=1` like in the
6766
following example.
6867

6968
```
@@ -72,6 +71,7 @@ ENABLE_LINKCHECK=1 mdbook serve
7271

7372
## Synchronizing josh subtree with rustc
7473

75-
This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.github.io/josh/intro.html) subtree. You can use the [rustc-josh-sync](https://github.com/rust-lang/josh-sync) tool to perform synchronization.
74+
This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.github.io/josh/intro.html) subtree.
75+
You can use the [rustc-josh-sync](https://github.com/rust-lang/josh-sync) tool to perform synchronization.
7676

7777
You can find a guide on how to perform the synchronization [here](./src/external-repos.md#synchronizing-a-josh-subtree).

0 commit comments

Comments
 (0)