kazupon/gunshi
Grade a repo

95

/ 100

GradeA

Excellent work. The main thing left to polish is a contributing guide.

Top 6% of 5,156 graded repos

Gunshi: Modern javascript command-line library

Documentation89
Engineering99
Health95
TypeScript474MIT16d ago

Outstanding. A score of 95/100 puts this repo in a very small tier of truly well-engineered projects.

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  2. 2
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

  4. 4
    Dependency manifest6pt

    Add a `keywords` array to help people find your package on npm.

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.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

89

Contributing guide5pt72

Contributing guide is detailed and thorough.

README12pt90

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

99

Reproducibility6pt90

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

Tests18pt100

Test files detected (bump.config.test.ts).

CI/CD14pt100

CI is configured (.github/workflows/ci.yml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

95

Dependency manifest6pt85

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 25
    Forks
  • 108
    Releaseslatest 1y ago

Community

  • 71% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 474
    Watchers

Responsiveness

  • 2d 3h
    Median issue response
  • 2h
    Median PR merge time
  • 7
    Open issues
Repository files34 root entries
  • .githooks
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Renovate is configured (.github/renovate.json). Dependencies update automatically across every package manager it detects.
    Good: Issue or PR templates present.
  • .vscode
  • assets
  • bench
  • design
  • e2e
  • packages
  • playground
  • scripts
  • _typos.toml
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • .oxlintrc.json
  • .prettierignore
  • bump.config.test.ts
    Good: Test files detected (bump.config.test.ts).
  • bump.config.ts
  • CHANGELOG.md
  • CLAUDE.md
  • CONTRIBUTING.md
    Good: 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.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • eslint.config.ts
  • knip.config.ts
  • LICENSE
    Good: Licensed under MIT.
  • NOTES.md
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • README.md
    Good: 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.
  • tsconfig.ci.json
  • tsconfig.json
  • vitest.config.ts
  • vitest.e2e.config.ts
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/kazupon/gunshi)](https://www.repo-grade.com/report/kazupon/gunshi)

More graded TypeScript repos