google/comprehensive-rust

Update exercise boiler plate text to suggest working on the code locally

Open

#1 289 ouverte le 2 oct. 2023

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)Rust (32 954 stars) (2 009 forks)batch import
enhancementgood first issuehelp wanted

Description

As pointed out in https://github.com/google/comprehensive-rust/pull/1288#issuecomment-1743131185, we're giving mixed signals about how the exercises should be solved: in the Rust Playground or locally with Cargo?

This is mostly a remnant of how the course has evolved: it started out being very focused on the Playground, but later we started recommending a more regular Rust setup.

We should update the boiler plate text to be more consistent and to encourage people to use a local installation.

To streamline things, we could include the same text (using the mdbook {{#include }} syntax) from all the exercises and thus ensure everything is consistent.

Guide contributeur

Stack technique
rust
Domaine
documentationcontent
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 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
familiarity with mdbookbasic Rust knowledgegit and GitHub workflow
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90
Direction de recherche
Review the comment in PR #1288 for the specific suggestion. Locate the exercise boilerplate files (likely in the `exercises` directory) that contain the text to be updated. Ensure consistency by using `{{#include}}` to include a common text snippet. Verify that the new text encourages local Cargo usage while still mentioning the playground as an option. After making changes, run `mdbook build` to ensure the book compiles correctly.