google/comprehensive-rust

Unify setup instructions

Open

#1 426 ouverte le 25 oct. 2023

Voir sur GitHub
 (3 commentaires) (0 réactions) (1 assigné)Rust (2 009 forks)batch import
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (32 954 stars)
Métriques de merge PR
 (Merge moyen 9j 23h) (36 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Examinez les instructions de configuration actuelles dans CONTRIBUTING.md (https://github.com/google/comprehensive rust/blob/main/CONTRIBUTING.md#formatting) et TRANSLATIONS.md (https://github.com/google/comprehensive rust/blob/main/TRANSLATIONS.md#preparation). La tâche consiste à consolider toutes les étapes d'installation des outils dans CONTRIBUTING.md, en veillant à ce qu'il n'y ait pas de duplication. Ensuite, mettez à jour TRANSLATIONS.md et README.md pour qu'ils fassent référence à la nouvelle section unifiée. Aucun codage n'est requis, uniquement des modifications de documentation.
Stack technique
rust
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90