82/ 100 · B

Popular and well-maintained. A little polish away from elite status.

Web-Scale Blockchain for fast, secure, scalable, decentralized apps and marketplaces.

Rust14,908 starsApache-2.0updated 1y ago
DocumentationREADME, setup, examples, license
94
EngineeringTests, CI, linting, lockfiles
79
Project healthDescription, activity, stars, deps
71

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

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  3. 3
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

Detailed breakdown

Documentation

94
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • 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 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 describes code style expectations.
    • 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 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

79
  • Tests90
    • Test files detected (bench-tps/tests).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD57

    Not applicable?

    • CI is configured (.github/workflows/cargo.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 does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • 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
    • Linter or formatter configured (docs/.eslintrc).
  • Reproducibility92
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via ci/docker/Dockerfile.
    • Dependabot configured for cargo.
    • Dependabot only covers one ecosystem (+12 pts; covering 2+ earns +20 pts).Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

71
  • 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.
  • Activity20
    • No pushes in over a year.A recent commit signals the project is alive and worth contributing to.
    • 14,908 stars.
  • Housekeeping100
    • .gitignore present.
Repository files127 root entries
  • .buildkite
  • .github
    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.
    Good: Contributing guide describes code style expectations.
    Info: 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.
    Good: Contributing guide includes code examples.
    Good: CI is configured (.github/workflows/cargo.yml).
    Good: Dependabot configured for cargo.
    Good: Issue or PR templates present.
  • account-decoder
  • accounts-bench
  • accounts-cluster-bench
  • accounts-db
  • banking-bench
  • banks-client
  • banks-interface
  • banks-server
  • bench-streamer
  • bench-tps
    Good: Test files detected (bench-tps/tests).
  • bloom
  • bucket_map
  • cargo-registry
  • cd
  • ci
    Good: Environment pinned via ci/docker/Dockerfile.
  • clap-utils
  • clap-v3-utils
  • cli
  • cli-config
  • cli-output
  • client
  • client-test
  • connection-cache
  • core
  • cost-model
  • docs
    Good: Linter or formatter configured (docs/.eslintrc).
  • dos
  • download-utils
  • entry
  • faucet
  • frozen-abi
  • genesis
  • genesis-utils
  • geyser-plugin-interface
  • geyser-plugin-manager
  • gossip
  • install
  • keygen
  • ledger
  • ledger-tool
  • local-cluster
  • log-analyzer
  • logger
  • measure
  • memory-management
  • merkle-root-bench
  • merkle-tree
  • metrics
  • multinode-demo
  • net
  • net-shaper
  • net-utils
  • notifier
  • perf
  • poh
  • poh-bench
  • program-runtime
  • program-test
  • programs
  • pubsub-client
  • quic-client
  • rayon-threadlimit
  • rbpf-cli
  • remote-wallet
  • rpc
  • rpc-client
  • rpc-client-api
  • rpc-client-nonce-utils
  • rpc-test
  • runtime
  • runtime-transaction
  • scripts
  • sdk
  • send-transaction-service
  • stake-accounts
  • storage-bigtable
  • storage-proto
  • streamer
  • svm
  • system-test
  • test-validator
  • thin-client
  • tokens
  • tpu-client
  • transaction-dos
  • transaction-status
  • turbine
  • udp-client
  • unified-scheduler-logic
  • unified-scheduler-pool
  • upload-perf
  • validator
  • version
  • vote
  • watchtower
  • web3.js
  • wen-restart
  • zk-keygen
  • zk-token-sdk
  • .clippy.toml
  • .codecov.yml
  • .gitignore
    Good: .gitignore present.
  • .mergify.yml
  • .travis.yml
  • cargo
  • cargo-build-bpf
  • cargo-build-sbf
  • cargo-test-bpf
  • cargo-test-sbf
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • CONTRIBUTING.md
  • fetch-perf-libs.sh
  • fetch-spl.sh
  • LICENSE
    Good: Licensed under Apache-2.0.
  • nextest.toml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.md
  • run.sh
  • rust-toolchain.toml
  • rustfmt.toml
  • SECURITY.md
    Good: Security policy present.
  • test-abi.sh
  • vercel.json