databendlabs/openraft
Grade a repo

95

/ 100

GradeA

Excellent work. The main thing left to polish is a contributing guide.

Top 5% of 5,156 graded repos

rust raft with improvements

Documentation87
Engineering100
Health100
Rust2,097Apache-2.023d ago

Outstanding. A score of 96/100 puts this repo in a very small tier of truly well-engineered projects.

Top fixes

Highest-impact changes first, ranked by point weight

7 to address
  1. 1
    README12pt

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

  2. 2
    Install and run instructions9pt

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

  3. 3
    Contributing guide5pt

    Add setup instructions, code style notes, and how to run tests.

  4. 4
    Contributing guide5pt

    Show new contributors how to get a local dev environment running.

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

87

Contributing guide5pt69

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.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

100

Tests18pt100

Test files detected (benchmarks/minimal/tests).

CI/CD14pt100

CI is configured (.github/workflows/ci.yaml).

Linting and formatting5pt100

Rust linting configured (rustfmt.toml, cargo clippy in CI, cargo fmt in CI).

Reproducibility6pt100

Lockfile present (scripts/requirements.txt). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

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

  • -
    Commits (30d / 90d)
  • 259
    Forks
  • 36
    Releaseslatest 3y ago

Community

  • 87% - Good
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 2,097
    Watchers

Responsiveness

  • <1h
    Median issue response
  • 1h
    Median PR merge time
  • 35
    Open issues
Repository files38 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yaml).
    Good: Dependabot covers 2 ecosystems (cargo, cargo). Dependencies stay current.
    Good: Issue or PR templates present.
  • assets
  • benchmarks
    Good: Test files detected (benchmarks/minimal/tests).
  • change-log
  • examples
  • guide
  • jepsen
    Good: Environment pinned via jepsen/docker/docker-compose.yml.
  • legacy
  • macros
  • metrics-otel
  • multiraft
  • openraft
  • rt
  • rt-compio
  • rt-monoio
  • rt-sim
  • rt-tokio
  • scripts
    Good: Lockfile present (scripts/requirements.txt). Installs are reproducible.
  • stores
  • tests
  • tests-turmoil
  • .gitignore
    Good: .gitignore present.
  • .mergify.yml
  • AGENTS.md
  • book.toml
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • change-log.md
  • CLAUDE.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.
    Good: Contributing guide describes code style expectations.
    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.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • derived-from-async-raft.md
  • LICENSE-APACHE
  • LICENSE-MIT
  • Makefile
  • raft-essentials.md
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
  • rust-toolchain
  • rustfmt.toml
    Good: Rust linting configured (rustfmt.toml, cargo clippy in CI, cargo fmt in CI).
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/databendlabs/openraft)](https://www.repo-grade.com/report/databendlabs/openraft)

More graded Rust repos