google/comprehensive-rust

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

Open

#1,289 创建于 2023年10月2日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)Rust (32,954 star) (2,009 fork)batch import
enhancementgood first issuehelp wanted

描述

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.

贡献者指南

技术栈
rust
领域
documentationcontent
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
familiarity with mdbookbasic Rust knowledgegit and GitHub workflow
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
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.