0
/ 100
Good shape overall. A few tweaks would push it into the top tier.
Builds API CLI plugin
Top fixes
Highest-impact changes first, ranked by point weight
- 1CI/CD14pt
Add `pull_request:` to the workflow `on:` triggers.
- 2CI/CD14pt
Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
- 3CI/CD14pt
Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
- 4README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
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
README is present.
README documents how to install the project.
Contributing guide is detailed and thorough.
Licensed under ISC.
Engineering
95
CI is configured (.github/workflows/ci.yml).
Test files detected (.mocharc.json).
Linter or formatter configured (.editorconfig).
Lockfile present (yarn.lock). Installs are reproducible.
Issue or PR templates present.
Project health
100
Dependency manifest found (package.json).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 29Forks
- 13Releaseslatest 1y ago
Community
- -Community health
- -authors own >50% of commits
- 137Watchers
Responsiveness
- 11hMedian issue response
- 17hMedian PR merge time
- 20Open issues
Repository files21 root entries
- .githubGood: CI is configured (.github/workflows/ci.yml).Good: Dependabot covers 2 ecosystems (github-actions, npm). Dependencies stay current.Good: Issue or PR templates present.
- bin
- scripts
- src
- test
- .editorconfigGood: Linter or formatter configured (.editorconfig).
- .gitignoreGood: .gitignore present.
- .mocharc.jsonGood: Test files detected (.mocharc.json).
- .nycrc.json
- .tool-versionsGood: Environment pinned via .tool-versions.
- CHANGELOG.md
- CODEOWNERS
- CONTRIBUTING.mdGood: Contributing guide is detailed and thorough.Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.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.Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
- eslint.config.mjs
- LICENSEGood: Licensed under ISC.
- package.jsonGood: Dependency manifest found (package.json).
- README.mdGood: 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.Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.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.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
- release-channels.yml
- SECURITY.mdGood: Security policy present.
- tsconfig.json
- yarn.lockGood: Lockfile present (yarn.lock). Installs are reproducible.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/heroku/heroku-builds)