Skip to content

Commit 00a47e3

Browse files
Kobzollnicola
andauthored
Apply suggestions from code review
Co-authored-by: Laurențiu Nicola <[email protected]>
1 parent 9c1750d commit 00a47e3

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/book/src/contributing/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -282,26 +282,27 @@ There are two sets of people with extra permissions:
282282
## Synchronizing subtree changes
283283
`rust-analyzer` is a [josh](https://josh-project.github.io/josh/intro.html) subtree of the [rust-lang/rust](https://github.com/rust-lang/rust)
284284
repository. We use the [rustc-josh-sync](https://github.com/rust-lang/josh-sync) tool to perform synchronization between these two
285-
repositories. You can find documentation of the tool [here](https://github.com/rust-lang/josh-sync?tab=readme-ov-file#performing-pull).
285+
repositories. You can find documentation of the tool [here](https://github.com/rust-lang/josh-sync).
286286
287287
You can install the synchronization tool using the following commands:
288288
```
289289
cargo install --locked --git https://github.com/rust-lang/josh-sync
290290
```
291291
292-
Both pulls (synchronize changes from rust-lang/rust into rust-analyzer) and pushes (synchronize
292+
Both pulls (synchronizing changes from rust-lang/rust into rust-analyzer) and pushes (synchronizing
293+
changes from rust-analyzer into rust-lang/rust) are performed from this repository.
293294
changes from rust-analyzer to rust-lang/rust) are performed from this repository.
294295
295296
Usually we first perform a pull, wait for it to be merged, and then perform a push.
296297
297298
### Performing a pull
298-
1) Checkout a new branch that will be used to create a PR into rust-analyzer
299+
1) Checkout a new branch that will be used to create a PR against rust-analyzer
299300
2) Run the pull command
300301
```
301302
rustc-josh-sync pull
302303
```
303304
3) Push the branch to your fork of `rust-analyzer` and create a PR
304-
- If you have `gh` CLI installed, `rustc-josh-sync` can create the PR for you.
305+
- If you have the `gh` CLI installed, `rustc-josh-sync` can create the PR for you.
305306
306307
### Performing a push
307308

0 commit comments

Comments
 (0)