cloudflare/pingoraNew scan
87/ 100 · B

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

A library for building fast, reliable and evolvable network services.

Rust26,827 starsApache-2.0updated 12d ago
DocumentationREADME, setup, examples, license
83
EngineeringTests, CI, linting, lockfiles
88
Project healthDescription, activity, stars, deps
92

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

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

  2. 2
    README
    DocumentationInfo

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

  3. 3
    README
    DocumentationInfo

    Add CI/build status badges from shields.io or your CI provider to signal project health.

Detailed breakdown

Documentation

83
  • README75
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • 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 instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide70
    • CONTRIBUTING guide or docs directory present.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

88
  • Tests90
    • Test files detected (pingora-core/tests).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/build.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
  • Linting and formatting80
    • Rust linting enforced in CI: cargo clippy + cargo fmt.
  • Reproducibility60
    • No Cargo.lock committed. Correct for Rust library crates (Rust ecosystem convention).For Rust binaries/applications, commit Cargo.lock. For library-only crates, omitting it is the recommended practice per the Cargo guide.
    • Environment pinned via Dockerfile.
    • Consider using a multi-stage Dockerfile (builder + runtime stage) for smaller, more secure images.Use a multi-stage Dockerfile.
    • 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.
  • Issue and PR templates90
    • Issue or PR templates present.
    • 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 manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml is a workspace manifest for a multi-crate Rust project.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 26,827 stars.
  • Housekeeping100
    • .gitignore present.
Repository files34 root entries
  • .cargo
  • .github
    Good: CONTRIBUTING guide or docs directory present.
    Good: CI is configured (.github/workflows/build.yml).
    Good: Issue or PR templates present.
  • docs
  • pingora
  • pingora-boringssl
  • pingora-cache
  • pingora-core
    Good: Test files detected (pingora-core/tests).
  • pingora-error
  • pingora-header-serde
  • pingora-http
  • pingora-ketama
  • pingora-limits
  • pingora-load-balancing
  • pingora-lru
  • pingora-memory-cache
  • pingora-openssl
  • pingora-pool
  • pingora-prometheus
  • pingora-proxy
  • pingora-runtime
  • pingora-rustls
  • pingora-s2n
  • pingora-timeout
  • tinyufo
  • .bleep
  • .gitignore
    Good: .gitignore present.
  • .rustfmt.toml
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • cliff.toml
  • clippy.toml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Info: 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.
    Info: 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.
    Good: README documents how to run the project.