n0-computer/irohNew scan
95/ 100 · A

A well-known project done right. Strong docs and solid engineering throughout.

IP addresses break, dial keys instead. Modular networking stack in Rust.

Rust9,616 starsApache-2.0updated today

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

DocumentationREADME, setup, examples, license
85
EngineeringTests, CI, linting, lockfiles
100
Project healthDescription, activity, stars, deps
100

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
    DocumentationIssue

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  3. 3
    Install and run instructions
    DocumentationIssue

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

Detailed breakdown

Documentation

85
  • README80
    • README is present.
    • README is well structured with multiple sections.
    • 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 code examples.
    • 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.
    • 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 Apache-2.0.
  • Contributing guide72
    • 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.
    • 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 has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Code of conduct present.

Engineering

100
  • Tests100
    • Test files detected (iroh-relay/tests).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/ci.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.
    • CI includes a build step.
  • Linting and formatting100
    • Rust linting configured (cargo clippy in CI).
  • Reproducibility100
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via docker/Dockerfile.
    • Dependabot covers 3 ecosystems (github-actions, cargo, docker). Dependencies stay current.
  • Issue and PR templates100
    • 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

100
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml is a workspace manifest for a multi-crate Rust project.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 9,616 stars.
  • Housekeeping100
    • .gitignore present.
Repository files29 root entries
  • .cargo
  • .config
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 3 ecosystems (github-actions, cargo, docker). Dependencies stay current.
    Good: Issue or PR templates present.
  • .img
  • docker
    Good: Environment pinned via docker/Dockerfile.
  • iroh
  • iroh-base
  • iroh-dns
  • iroh-dns-server
  • iroh-relay
    Good: Test files detected (iroh-relay/tests).
  • .dockerignore
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .typos.toml
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG_old.md
  • CHANGELOG.md
  • cliff.toml
  • code_of_conduct.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
    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.
  • deny.toml
  • example.config.toml
  • LICENSE-APACHE
  • LICENSE-MIT
  • Makefile.toml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README has code examples.
    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.toml
  • TRANSPORTS.md