Skip to content

Commit d1409bb

Browse files
authored
Fix typos and clarify wording (#414)
* Fix typos and clarify wording * Small fixes in README 'Adding teams' section
1 parent c626f3b commit d1409bb

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,19 +48,19 @@ standard --fix js/
4848

4949
# Contributing
5050

51-
## Adding Teams
51+
## Adding teams
5252

53-
Any Rust team can have a section in the Rust Forge. If you'd like to add your team you first need to add them as an item to `src/SUMMARY.md`, like so replacing `TEAM NAME` with your respective team's name to show on forge, and `<TEAM_NAME>` with a filesystem and url friendly version of that name where your documentation will be stored.
53+
Any Rust team can have a section in the Rust Forge. If you'd like to add your team, you first need to add them as an item to `src/SUMMARY.md`, like below, replacing `TEAM NAME` with your respective team's name to show on Forge, and `<TEAM_NAME>` with a filesystem- and URL-friendly version of that name where your documentation will be stored.
5454

5555
```markdown
5656
- [TEAM NAME](src/<TEAM_NAME>/README.md)
5757
<!-- or -->
5858
- [TEAM NAME](src/<TEAM_NAME>.md)
5959
```
6060

61-
If you run `mdbook build`, `mdbook` will automatically create the folder and file for your team.
61+
If you run `mdbook build`, `mdbook` will automatically create the folder and file for your team.
6262

63-
It's recommended that you put general team information in `src/<TEAM_NAME>/README.md` such as where the meetings happen, repositories that the team manages, links to chat platforms, etc. Larger topics should be made as a subpage e.g. (`src/release/topic.md`).
63+
It's recommended that you put general team information in `src/<TEAM_NAME>/README.md`, such as where the meetings happen, repositories that the team manages, links to chat platforms, etc. Larger topics should be made as a subpage e.g. (`src/release/topic.md`).
6464

6565
```markdown
6666
- [TOPIC](src/<TEAM_NAME>/TOPIC.md)

src/platforms/email.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ mailing lists for teams through the [rust-lang/team] repository. Our email
77
domain is `rust-lang.org`, e.g. `ferris@rust-lang.org`.
88

99
## Sending a public broadcast
10-
If your teams need to reach everyone in Rust organisation they can send a
10+
If your teams need to reach everyone in the Rust organisation, they can send an
1111
email to `all@`. It is recommended that you only use this mailing list when you
12-
know that you need contact every member, such as for organising a members event
13-
like the All Hands, or security alerts.
12+
know that you need to contact every member, such as for organising a members event
13+
like the All Hands, or for security alerts.
1414

1515
### Keeping responses private
1616
When sending a message to `all@`, do not put `all@` in `To`. This will mean that
17-
any replies to your broadcast will also be sent to everyone. Instead put your
17+
any replies to your broadcast will also be sent to everyone. Instead, put your
1818
team's email address in `To` field, and place `all@` in the `Bcc` field. Then
1919
any replies will be sent to just your team.
2020

src/platforms/github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# GitHub
2-
Github is where the Rust project hosts all of its code, as well as a large parts
2+
Github is where the Rust project hosts all of its code, as well as large parts
33
of its discussions.
44

55
## Organisations

0 commit comments

Comments
 (0)