English style guide

Open
#2,045 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start with docs/authoring.md#style to assess the current English guidance, then review the linked collection of style guides for possible conventions to adopt. Done means either adding the agreed English style rules to the guide or linking to a suitable external guide.

Written by the indexing model from the issue text.

Description

Authoring guide Meta

We currently have a meager English style guide at https://github.com/rust-lang/reference/blob/master/docs/authoring.md#style. The intent was to expand that with either linking to another style guide, or expanding it with whatever rules we decide on. I think it would be helpful to give more guidance on the English style and conventions.

We have a collection of style guides at https://hackmd.io/@rust-spec-team/rkj1RS3uR

Dominant language
Rust
Stars
1.6k
Forks
607
Avg merge
1d 1h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-lang/reference

All issues in rust-lang/reference

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.