Document dist components we ship
Open
Nobody has claimed this yet.
A-dist-components
A-docs
C-tracking-issue
T-bootstrap
T-compiler
T-release
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
E.g. https://github.com/rust-lang/rust/issues/138647.
We should document:
- What each dist component is intended for?
- What guarantees do we have for dist components?
- Directory structure?
- Archive format?
- Buildability?
- Other properties?
- Stability?
- Are there any test coverage for said dist components? cf. https://github.com/rust-lang/rust/issues/136822.
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 by reviewing the linked issues rust-lang/rust#138647 and rust-lang/rust#136822, then inventory the distribution components being shipped. Done means documenting each component’s intended use, supported guarantees, and any existing or missing test coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100