google/comprehensive-rust

Unify setup instructions

Open

#1.426 geöffnet am 25. Okt. 2023

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Rust (32.954 Stars) (2.009 Forks)batch import
documentationgood first issuehelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
blocked
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic familiarity with MarkdownGitHub workflowCLI usage
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85
Research-Richtung
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.