google/comprehensive-rust

Unify setup instructions

Open

#1,426 opened on Oct 25, 2023

View on GitHubContributor guide
 (3 comments) (0 reactions) (1 assignee)Rust (2,009 forks)batch import
documentationgood first issuehelp wanted

Repository metrics

Stars
 (32,954 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Consolidate setup instructions from CONTRIBUTING.md and TRANSLATIONS.md into a single place in CONTRIBUTING.md, then update references in TRANSLATIONS.md and README.md.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90