ffgenius/relay
Grade a repo

0

/ 100

GradeB

Strong early engineering with some momentum.

Top 32% of 5,156 graded repos

Secure Cross-Platform Command Router

Documentation59
Engineering87
Health98
Rust171mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    README12pt

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

  2. 2
    Install and run instructions9pt

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

  3. 3
    License6pt

    Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

  4. 4
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

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

59

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

README12pt80

README is present.

Install and run instructions9pt90

README documents how to install the project.

Engineering

87

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt95

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

Tests18pt100

Test files detected (tests).

CI/CD14pt100

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

Linting and formatting5pt100

Rust linting configured (rustfmt.toml, cargo clippy in CI, cargo fmt in CI).

Project health

98

Dependency manifest6pt95

Dependency manifest found (Cargo.toml).

Repository metadata5pt100

Repository has a description.

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
  • 0
    Releases

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 17
    Watchers

Responsiveness

  • -
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files12 root entries
  • .githooks
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 3 ecosystems (cargo, github-actions, npm). Dependencies stay current.
  • npm
  • src
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.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.
  • README.zh.md
  • rust-toolchain.toml
  • rustfmt.toml
    Good: Rust linting configured (rustfmt.toml, cargo clippy in CI, cargo fmt in CI).
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/ffgenius/relay)](https://www.repo-grade.com/report/ffgenius/relay)

More graded Rust repos