dtolnay/anyhowNew scan
75/ 100 · C

Good community traction and solid fundamentals. Nearly in the top tier.

Flexible concrete Error type built on std::error::Error

Rust6,558 starsApache-2.0updated 2mo ago
DocumentationREADME, setup, examples, license
74
EngineeringTests, CI, linting, lockfiles
68
Project healthDescription, activity, stars, deps
95

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
    DocumentationWarning

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

  3. 3
    Install and run instructions
    DocumentationInfo

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

Detailed breakdown

Documentation

74
  • 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.
    • 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 guide0
    • No CONTRIBUTING.md found (−45 pts base + up to −53 pts more for content).Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
    • 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

68
  • Tests90
    • Test files detected (tests).
    • Cargo.toml has dev-dependencies and test files are present.
  • 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 tests across multiple environments or versions.
  • Linting and formatting60
    • CI runs cargo clippy for Rust linting.
    • CI does not run `cargo fmt --check` (−20 pts vs clippy + fmt).Add `cargo fmt --check` to CI to enforce consistent formatting.
    • No rustfmt.toml found.Add a rustfmt.toml to enforce a consistent code style across contributors.
  • Reproducibility5
    • No Cargo.lock found (−70 pts). Rust binary/application crates should commit Cargo.lock.Run `cargo build` and commit the resulting Cargo.lock file.
    • 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.
    • Cargo.toml uses Rust edition 2021 (current best practice).
  • Issue and PR templates0
    • No issue or PR templates found (−90 pts).Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

95
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml includes a description for crates.io.
    • Cargo.toml declares a license.
    • Cargo.toml links to the source repository.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Rust.
    • Cargo.toml [package] metadata is complete (description, authors, repository).
  • Activity80
    • Actively maintained (pushed within 3 months).
    • 6,558 stars.
  • Housekeeping100
    • .gitignore present.
Repository files10 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • src
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • build.rs
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • LICENSE-APACHE
  • LICENSE-MIT
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: 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.
  • rust-toolchain.toml