google/comprehensive-rust

Unify setup instructions

Open

#1426 opened on Oct 25, 2023

View on GitHub
 (3 comments) (0 reactions) (1 assignee)Rust (32,954 stars) (2,009 forks)batch import
documentationgood first issuehelp wanted

Description

We now have both Formatting and Preparation as places where we explain how to install the necessary tooling. I would suggest that we unify this into a single location (I'm thinking CONTRIBUTING.md) and then point people to that file from both TRANSLATIONS.md and README.md etc.

Originally posted by @mgeisler in https://github.com/google/comprehensive-rust/issues/1394#issuecomment-1778854142

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic familiarity with MarkdownGitHub workflowCLI usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the current setup instructions in CONTRIBUTING.md (https://github.com/google/comprehensive rust/blob/main/CONTRIBUTING.md#formatting) and TRANSLATIONS.md (https://github.com/google/comprehensive rust/blob/main/TRANSLATIONS.md#preparation). The task is to consolidate all tooling installation steps into CONTRIBUTING.md, ensuring no duplication. Then update TRANSLATIONS.md and README.md to reference the new unified section. No coding is required, only documentation edits.