google/comprehensive-rust

Explicitly call out dev-dependencies used in solutions

Closed

#1,290 opened on Oct 2, 2023

View on GitHubContributor guide
 (0 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

From https://github.com/google/comprehensive-rust/pull/1288#issuecomment-1743131185: the safe FFI wrapper solution does not actually work when you copy-paste it into a new Cargo project. The problem is that the unit tests rely on tempfile.

We need to fix this: I suggest adding some text to the solution which shows the cargo add commands to run. Alternatively, we could {{#include ...}} the Cargo.toml file — but I fear this will become messy since all solutions currently share a single Cargo.toml file. We could perhaps split them up further?

Contributor guide

Research direction
Investigate the solution file at exercises/day 3/solutions afternoon.html and its Cargo.toml. The issue references PR #1288, which may contain discussion. Consider adding a note in the solution text listing the required `cargo add` commands for dev dependencies like tempfile. Alternatively, evaluate splitting the shared Cargo.toml to include per solution dev dependencies. Ensure the solution works when copy pasted into a new project.
Tech stack
rust
Domain
documentationdeveloper experiencetesting
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.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust basicsCargo dev dependencies
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90