67
/ 100
Solid engineering. The biggest lever is setup instructions.
Top fixes
Highest-impact changes first, ranked by point weight
- 1README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
- 2Install and run instructions9pt
Add a section showing how to install dependencies.
- 3Install and run instructions9pt
Add a section showing how to start or use the project.
- 4Install and run instructions9pt
Add a .env.example listing all required environment variables so contributors know what to set up.
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
56
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
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.
README is present.
Licensed under Apache-2.0.
Engineering
84
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.
Lockfile present (Cargo.lock). Installs are reproducible.
Test files detected (crates/zeff-emu-common/src/replay/tests).
CI is configured (.github/workflows/ci.yml).
Rust linting configured (cargo clippy in CI, cargo fmt in CI).
Project health
81
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 manifest found (Cargo.toml).
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 0Forks
- 9Releaseslatest 1mo ago
Community
- 28% - WeakCommunity health
- 1 bus factorlowauthor own >50% of commits
- 0Watchers
Responsiveness
- -Median issue response
- -Median PR merge time
- 0Open issues
Repository files28 root entries
- .cargo
- .githubGood: CI is configured (.github/workflows/ci.yml).
- assets
- cratesGood: Test files detected (crates/zeff-emu-common/src/replay/tests).
- examples
- fuzz
- images
- packaging
- rom-tests
- scripts
- snap
- src
- tests
- third_partyGood: Licensed under Apache-2.0.
- .gitignoreGood: .gitignore present.
- build.rs
- Cargo.lockGood: Lockfile present (Cargo.lock). Installs are reproducible.
- Cargo.tomlGood: Dependency manifest found (Cargo.toml).
- clippy.toml
- coi-serviceworker.js
- deny.toml
- index.html
- justfile
- LICENSE-APACHE
- LICENSE-MIT
- README.mdGood: 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.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
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/zeffuro/zeff-boy)