google/comprehensive-rust

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

Open

#1.289 geöffnet am 2. Okt. 2023

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (32.954 Stars) (2.009 Forks)batch import
enhancementgood first issuehelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
rust
Domain
documentationcontent
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.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
familiarity with mdbookbasic Rust knowledgegit and GitHub workflow
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90
Research-Richtung
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.