npm/documentation

0

/ 100

Documentation87
Engineering99
Health92
MDX670CC-BY-4.01d ago
Grade a repo

Polished and well engineered. Punching above its star count.

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

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)
  • 3,998
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 670
    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