Good shape overall. A few tweaks would push it into the top tier.
Builds API CLI plugin
Documentation
56
README12pt
35
README is present.
Install and run instructions9pt
45
README documents how to install the project.
Contributing guide5pt
75
Contributing guide is detailed and thorough.
License6pt
100
Licensed under ISC.
Engineering
95
CI/CD14pt
83
CI is configured (.github/workflows/ci.yml).
Tests18pt
100
Test files detected (.mocharc.json).
Linting and formatting5pt
100
Linter or formatter configured (.editorconfig).
Reproducibility6pt
100
Lockfile present (yarn.lock). Installs are reproducible.
Issue and PR templates6pt
100
Issue or PR templates present.
Project health
100
Dependency manifest6pt
100
Dependency manifest found (package.json).
Repository metadata5pt
100
Repository has a description.
Activity5pt
100
Actively maintained (pushed within the last month).
Housekeeping3pt
100
.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.