npm/documentation
Grade a repo

94

/ 100

GradeA

Polished and well engineered. Punching above its star count.

Top 7% of 5,156 graded repos

Documentation for the npm registry, website, and command-line interface.

Documentation87
Engineering99
Health92
MDX671CC-BY-4.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    README12pt

    Add more sections (Overview, Install, Usage, Contributing) using ## headings.

  2. 2
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

  3. 3
    Install and run instructions9pt

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

  4. 4
    Reproducibility6pt

    Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.

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

87

README12pt78

README is present.

Contributing guide5pt89

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under CC-BY-4.0.

Engineering

99

Reproducibility6pt92

Lockfile present (package-lock.json). Installs are reproducible.

Tests18pt100

Test files detected (cli/test).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.js).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

92

Dependency manifest6pt75

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)
  • 4,001
    Forks
  • 0
    Releases

Community

  • 87% - Good
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 671
    Watchers

Responsiveness

  • 2d 7h
    Median issue response
  • 4h
    Median PR merge time
  • 78
    Open issues
Repository files33 root entries
  • .github
    Good: CI is configured (.github/workflows/ci-cli.yml).
    Good: Dependabot configured for npm.
    Good: Issue or PR templates present.
  • .reuse
  • cli
    Good: Test files detected (cli/test).
  • content
  • LICENSES
  • scripts
  • src
  • static
  • .eslint.config.js
  • .eslintrc.js
    Good: Linter or formatter configured (.eslintrc.js).
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • .prettierignore
  • .prettierrc.js
  • cli-cache.json
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTENT-MODEL.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
    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.
  • gatsby-browser.js
  • gatsby-config.mjs
  • gatsby-node.mjs
  • gatsby-ssr.js
  • jest-preprocess.js
  • jest-setup.js
  • jest.config.js
  • LICENSE
    Good: Licensed under CC-BY-4.0.
  • LICENSE-CODE
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    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.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.
  • webpack.config.js
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/npm/documentation)](https://www.repo-grade.com/report/npm/documentation)

More graded MDX repos