f7rx/ferry
Grade a repo

0

/ 100

GradeA

Excellent work. The main thing left to polish is the repo description and topics. Impressive for a brand-new repo.

Top 8% of 5,156 graded repos
Documentation95
Engineering100
Health70
Rust1Apache-2.02d ago

Top fixes

Highest-impact changes first, ranked by point weight

10 to address
  1. 1
    Install and run instructions9pt

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

  2. 2
    Dependency manifest6pt

    Add a one-line description to package.json. It appears in npm search and on GitHub.

  3. 3
    Dependency manifest6pt

    Add a `repository` field pointing to the GitHub URL so npm knows where the source lives.

  4. 4
    Dependency manifest6pt

    Add a `keywords` array to help people find your package on npm.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

95

Contributing guide5pt86

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

100

Tests18pt100

Test files detected (apps/app/src/lib/format.test.ts).

CI/CD14pt100

CI is configured (.github/workflows/ci.yml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Reproducibility6pt100

Lockfile present (Cargo.lock). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

70

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt55

Dependency manifest found (Cargo.toml).

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 0
    Forks
  • 1
    Releaseslatest 2d ago

Community

  • 71% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 1
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 4
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 3 ecosystems (cargo, npm, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • apps
    Good: Test files detected (apps/app/src/lib/format.test.ts).
  • crates
    Good: Environment pinned via crates/ferry-signal/Dockerfile.
  • docs
  • scripts
  • tests
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • NOTICE
  • package-lock.json
  • package.json
  • 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.
  • rustfmt.toml
  • SECURITY.md
    Good: Security policy present.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/f7rx/ferry)](https://www.repo-grade.com/report/f7rx/ferry)

More graded Rust repos