0
/ 100
Getting some notice. Tests and CI would be the fastest wins.
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
- 1CI/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.
- 2README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
- 3Install and run instructions9pt
Add a .env.example listing all required environment variables so contributors know what to set up.
- 4Reproducibility6pt
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
92
README is present.
README documents how to install the project.
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.
Licensed under Other.
Engineering
45
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 linter or formatter found.
→ Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.
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 (package-lock.json). Installs are reproducible.
Test files detected (tests).
Project health
73
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 files27 root entries
- account
- aseprite
- assets
- build
- data
- docs
- electron
- js
- media
- play
- server
- testsGood: Test files detected (tests).
- tools
- .gitignoreGood: .gitignore present.
- CLAUDE.md
- CODE_OF_CONDUCT.mdGood: Code of conduct present.
- CONTRIBUTING.mdIssue: 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.
- favicon.ico
- index.html
- LICENSEGood: Licensed under Other.
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.jsonGood: Dependency manifest found (package.json).
- privacy.html
- 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.Good: README documents how to install the project.Good: README documents how to run the project.
- site.css
- terms.html
- todo.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/curzel-it/sneakbit)