zeffuro/zeff-boy
Grade a repo

0

/ 100

GradeD

A workable base with real gaps. Start with setup instructions and issue and PR templates.

Top 49% of 5,156 graded repos
Documentation44
Engineering77
Health81
Rust0Apache-2.08d ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (85).

See your top fixes
Now
D
67
Potential
B
85

Top fixes

Highest-impact changes first, ranked by point weight

18 to address
  1. 1
    Tests18pt

    Add test/dev tooling under [dev-dependencies] so `cargo test` runs a complete suite.

  2. 2
    README12pt

    Expand with a description, install steps, usage, and examples.

  3. 3
    README12pt

    Add more sections (Overview, Install, Usage, Contributing) using ## headings.

  4. 4
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

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

44

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

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.

README12pt58

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

77

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.

Reproducibility6pt70

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

Tests18pt80

Test files detected (crates/zeff-emu-common/src/replay/tests).

CI/CD14pt100

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

Linting and formatting5pt100

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

Project health

81

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 manifest6pt90

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
  • 6
    Releaseslatest 14d ago

Community

  • 28% - Weak
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 0
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files26 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • assets
  • crates
    Good: Test files detected (crates/zeff-emu-common/src/replay/tests).
  • fuzz
  • images
  • packaging
  • rom-tests
  • scripts
  • snap
  • src
  • tests
  • third_party
    Good: Licensed under Apache-2.0.
  • .gitignore
    Good: .gitignore present.
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • clippy.toml
  • coi-serviceworker.js
  • deny.toml
  • index.html
  • justfile
  • LICENSE-APACHE
  • LICENSE-MIT
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • THIRD_PARTY_NOTICES.md
  • Trunk.toml
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/zeffuro/zeff-boy)](https://www.repo-grade.com/report/zeffuro/zeff-boy)

More graded Rust repos