rust-lang/mdbook
Grade a repo

91

/ 100

GradeA

Excellent work. The main thing left to polish is the README.

Top 11% of 5,156 graded repos

Create book from markdown files. Like Gitbook but implemented in Rust

Documentation85
Engineering96
Health86
Rust22,012MPL-2.011d ago

Top fixes

Highest-impact changes first, ranked by point weight

12 to address
  1. 1
    README12pt

    Expand with a description, install steps, usage, and examples.

  2. 2
    README12pt

    Add more sections (Overview, Install, Usage, Contributing) using ## headings.

  3. 3
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

  4. 4
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

85

README12pt68

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MPL-2.0.

Contributing guide5pt100

Contributing guide is detailed and thorough.

Engineering

96

Reproducibility6pt70

Lockfile present (Cargo.lock). Installs are reproducible.

Tests18pt100

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/main.yml).

Linting and formatting5pt100

Linter or formatter configured (eslint.config.mjs).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

86

Dependency manifest6pt55

Dependency manifest found (Cargo.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 5 / 32
    Commits (30d / 90d)
  • 1,877
    Forks
  • 103
    Releaseslatest 10y ago

Community

  • 75% - Good
    Community health
  • 3 bus factor
    authors own >50% of commits
  • 22,012
    Watchers

Responsiveness

  • 14d 3h
    Median issue response
  • 2h
    Median PR merge time
  • 695
    Open issues
Repository files22 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/main.yml).
    Good: Issue or PR templates present.
  • ci
  • crates
  • examples
  • guide
  • src
  • tests
    Good: Test files detected (tests).
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • eslint.config.mjs
    Good: Linter or formatter configured (eslint.config.mjs).
  • LICENSE
    Good: Licensed under MPL-2.0.
  • package.json
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • rustfmt.toml
  • triagebot.toml
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/rust-lang/mdbook)](https://www.repo-grade.com/report/rust-lang/mdbook)

More graded Rust repos