rust-lang / rust-lang/reference
English style guide
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100