storybookjs/storybookNew scan
87/ 100 · B

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Storybook is the industry standard workshop for building, documenting, and testing UI components in isolation

TypeScript90,337 starsMITupdated 2d ago
DocumentationREADME, setup, examples, license
83
EngineeringTests, CI, linting, lockfiles
95
Project healthDescription, activity, stars, deps
72

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  2. 2
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  3. 3
    Install and run instructions
    DocumentationWarning

    Add a section showing how to start or use the project.

Detailed breakdown

Documentation

83
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions45
    • README documents how to install the project.
    • No run or usage instructions found (−45 pts).Add a section showing how to start or use the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide87
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide lacks a testing section (−8 pts).Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

95
  • Tests100
    • Test files detected (code/addons/a11y/src/a11yRunner.test.ts).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/fork-checks.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
  • Linting and formatting75
    • Linter or formatter configured (.editorconfig).
    • Lint script wired into package.json.
  • Reproducibility80
    • Lockfile present (yarn.lock). Installs are reproducible.
    • Environment pinned via .nvmrc.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

72
  • Dependency manifest55
    • Dependency manifest found (package.json).
    • package.json is missing a description (−10 pts).Add a one-line description to package.json. It appears in npm search and on GitHub.
    • package.json has no repository field (−10 pts).Add a `repository` field pointing to the GitHub URL so npm knows where the source lives.
    • package.json has no keywords (−8 pts).Add a `keywords` array to help people find your package on npm.
    • package.json has no homepage field (−7 pts).Add a `homepage` field pointing to your docs or project website.
    • package.json has no build script (−10 pts).Add a `build` script to package.json so the project can be compiled with `npm run build`.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: TypeScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 90,337 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (.env) (−40 pts).Remove them and add to .gitignore.
Repository files49 root entries
  • .agents
  • .circleci
  • .claude
  • .cursor
  • .github
    Good: CI is configured (.github/workflows/fork-checks.yml).
    Good: Issue or PR templates present.
  • .husky
  • .nx
  • .vscode
  • .yarn
  • code
    Good: Test files detected (code/addons/a11y/src/a11yRunner.test.ts).
  • CONTRIBUTING
  • docs
  • scripts
  • test-storybooks
  • .cursorrules
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env
    Warning: Build artifacts or local files may be committed (.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .lintstagedrc.mjs
  • .mailmap
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • .oxfmtrc.json
  • .spelling
  • .yarnrc.yml
  • AGENTS.md
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Info: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Info: 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.
  • CHANGELOG.prerelease.md
  • CHANGELOG.v1-5.md
  • CHANGELOG.v6.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • CODEOWNERS
  • CONTRIBUTING.md
  • CONTRIBUTING.old.md
  • dependabot.yml
  • LICENSE
    Good: Licensed under MIT.
  • MAINTAINERS.md
  • MIGRATION.md
  • nx.json
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Warning: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • RESOLUTIONS.md
  • SECURITY.md
    Good: Security policy present.
  • storybook.code-workspace
  • vitest.config.ts
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.