0
/ 100
Popular for its size, but the engineering basics lag behind the interest.
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 (82).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add a scripts.test entry and create your first test file.
- 2CI/CD14pt
If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
- 3README12pt
Expand with a description, install steps, usage, and examples.
- 4README12pt
Add more sections (Overview, Install, Usage, Contributing) using ## headings.
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
64
No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).
→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
README is present.
README documents how to install the project.
Licensed under MIT.
Engineering
33
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
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.
A test framework is installed but no test script or test files were found.
→ Add a scripts.test entry and create your first test file.
Lockfile present (package-lock.json). Installs are reproducible.
Linter or formatter configured (eslint.config.mjs).
Project health
76
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 (package.json).
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 30Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 280Watchers
Responsiveness
- <1hMedian issue response
- -Median PR merge time
- 1Open issues
Repository files16 root entries
- app
- components
- lib
- public
- .gitignoreGood: .gitignore present.
- AGENTS.md
- baby.svg
- eslint.config.mjsGood: Linter or formatter configured (eslint.config.mjs).
- LICENSEGood: Licensed under MIT.
- next-env.d.ts
- next.config.ts
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.jsonGood: Dependency manifest found (package.json).
- README.mdGood: 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.Good: README has code examples.Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.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.Good: README documents how to install the project.Good: README documents how to run the project.
- THIRD_PARTY_NOTICES.md
- tsconfig.json
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/catsjuice/medal-forge)