hyperium/tonicNew scan
85/ 100 · B

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

A native gRPC client & server implementation with async/await support.

Rust12,293 starsMITupdated 11d ago
DocumentationREADME, setup, examples, license
88
EngineeringTests, CI, linting, lockfiles
80
Project healthDescription, activity, stars, deps
92

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringWarning

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    README
    DocumentationInfo

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

Detailed breakdown

Documentation

88
  • README85
    • 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.
    • README includes status badges.
  • 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 MIT.
  • Contributing guide78
    • Contributing guide is detailed and thorough.
    • 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 explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • 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

80
  • Tests90
    • Test files detected (tests).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD72

    Not applicable?

    • CI is configured (.github/workflows/CI.yml).
    • The CI workflow does not appear to run any tests (−28 pts).Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
    • 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.
    • CI includes a build step.
  • Linting and formatting80
    • Rust linting enforced in CI: cargo clippy + cargo fmt.
    • No rustfmt.toml found.Add a rustfmt.toml to enforce a consistent code style across contributors.
  • Reproducibility50
    • 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.
    • 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.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

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).
    • 12,293 stars.
  • Housekeeping100
    • .gitignore present.
Repository files32 root entries
  • .gemini
  • .github
    Good: CI is configured (.github/workflows/CI.yml).
    Good: Issue or PR templates present.
  • codegen
  • examples
  • grpc
  • grpc-google
  • grpc-protobuf
  • grpc-protobuf-build
  • interop
  • protoc-gen-rust-grpc
  • tests
    Good: Test files detected (tests).
  • tonic
  • tonic-build
  • tonic-health
  • tonic-prost
  • tonic-prost-build
  • tonic-protobuf
  • tonic-reflection
  • tonic-types
  • tonic-web
  • tonic-xds
  • xds-client
  • .gitignore
    Good: .gitignore present.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Info: 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 .).
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CONTRIBUTING.md
  • flake.lock
  • flake.nix
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • release-plz.toml
  • SECURITY.md
    Good: Security policy present.