google/comprehensive-rust

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

Open

#1,289 opened on Oct 2, 2023

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Rust (2,009 forks)batch import
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (32,954 stars)
PR merge metrics
 (Avg merge 9d 23h) (36 merged PRs in 30d)

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.

Contributor guide

Research direction
Review pull request #1288 comment for context, then locate all exercise markdown files in the repository, update the boilerplate text to recommend local Rust setup, and use {{#include}} to share the same text across exercises.
Tech stack
rust
Domain
documentationdeveloper experience
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.
Half day
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
GitRustmdbook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75