rust-lang/rustlingsNew scan
75/ 100 · C

Popular and well-maintained. A little polish away from elite status.

:crab: Small exercises to get you used to reading and writing Rust code!

Rust63,226 starsMITupdated 22d ago
DocumentationREADME, setup, examples, license
52
EngineeringTests, CI, linting, lockfiles
84
Project healthDescription, activity, stars, deps
92

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  2. 2
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  3. 3
    README
    DocumentationIssue

    Add an Overview, Install, Usage, and Contributing section at minimum.

Detailed breakdown

Documentation

52
  • README28
    • README is present.
    • README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Add an Overview, Install, Usage, and Contributing section at minimum.
    • README has some structure (−7 pts). 2–3 headings earns partial credit; 4+ earns the full +15 pts.Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • README links to a live demo or deployed app.
    • No status badges in the README (−10 pts).Add CI/build status badges from shields.io or your CI provider to signal project health.
  • Install and run instructions45
    • README documents how to install the project.
    • No run or usage instructions found (−45 pts).Add a section showing how to start or use the project.
    • No .env.example found (−10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide66
    • Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Add setup instructions, code style notes, and how to run tests.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide lacks a testing section (−8 pts).Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Optional: add a Code of Conduct.A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

84
  • Tests100
    • Test files detected (tests).
    • Cargo.toml has dev-dependencies and test files are present.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/rust.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI tests across multiple environments or versions.
  • Linting and formatting100
    • Rust linting configured (cargo clippy in CI, cargo fmt in CI).
  • Reproducibility70
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
    • Cargo.toml does not specify edition 2021.Add `edition = "2021"` to [package] in Cargo.toml for the latest Rust language features.
  • Issue and PR templates0
    • No issue or PR templates found (−100 pts).Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

92
  • Dependency manifest75
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml includes a description for crates.io.
    • Cargo.toml is missing a license field (−10 pts).Add `license = "MIT"` (or your preferred SPDX identifier) to [package].
    • Cargo.toml is missing a repository field (−10 pts).Add `repository = "https://github.com/owner/repo"` to [package].
    • Cargo.toml has no documentation link (−5 pts).Add `documentation = "https://docs.rs/<crate>"` to [package] so users can find the API docs.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 63,226 stars.
  • Housekeeping100
    • .gitignore present.
Repository files22 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/rust.yml).
  • dev
  • exercises
  • rustlings-macros
  • solutions
  • src
  • tests
    Good: Test files detected (tests).
  • website
  • .gitignore
    Good: .gitignore present.
  • .rumdl.toml
  • .typos.toml
  • build.rs
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • clippy.toml
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • dev-Cargo.toml
  • LICENSE
    Good: Licensed under MIT.
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has some structure (−7 pts). 2–3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • release-hook.sh