rust-lang / rust-lang/rustc-dev-guide

Double-check we did everything from rust-lang/rust#40902

Open
#448 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement C-tracking-issue E-needs-investigation T-compiler
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

rust-lang/rust#40902 had a long-ish ongoing list of items that we wanted to document somewhere official.

It was closed sometime after the rustc-guide was created, since it was no longer actionable within the rust-lang/rust repo. But I think there is some evidence that good ideas of things to document are still embedded in that issue and its comment thread.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reading rust-lang/rust#40902 and its comment thread, then compare its documentation ideas with the current rustc-guide. Identify which useful items are still missing and document them in the appropriate official guide location; the work is done when the actionable ideas have been covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.