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

Make contributing.md into a series of tutorials

Open
#775 7 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-contribution-workflows A-meta A-organization C-enhancement T-compiler
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

as per https://github.com/rust-lang/compiler-team/issues/296

cc @ecstatic-morse

We probably also want to figure out how to integrate relevant existing walkthrough sections (e.g. https://rustc-dev-guide.rust-lang.org/walkthrough.html) and planned ones.

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 with contributing.md and the existing walkthrough at rustc-dev-guide.rust-lang.org/walkthrough.html. Read the linked compiler-team issue #296 and review the planned and existing walkthrough sections. Done means contributing.md is organized as a series of tutorials with a clear approach for integrating relevant walkthrough material.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.