pmndrs/jotaiNew scan
93/ 100 · A

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

👻 Primitive and flexible state management for React

TypeScript21,194 starsMITupdated 4d ago
DocumentationREADME, setup, examples, license
93
EngineeringTests, CI, linting, lockfiles
90
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    CI/CD
    EngineeringInfo

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

Detailed breakdown

Documentation

93
  • 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 instructions90
    • README documents how to install the project.
    • README documents how to run 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 guide70
    • Contributing guide is detailed and thorough.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • 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.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

90
  • Tests100
    • Test files detected (tests).
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/test-multiple-builds.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • 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 tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting95
    • Linter or formatter configured (eslint.config.mjs).
    • Lint script wired into package.json.
    • tsconfig.json has `strict: true`. Full TypeScript type safety enabled.
  • Reproducibility70
    • Lockfile present (pnpm-lock.yaml). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • 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 templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: TypeScript.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 21,194 stars.
  • Housekeeping100
    • .gitignore present.
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/test-multiple-builds.yml).
    Good: Issue or PR templates present.
  • .livecodes
  • benchmarks
  • docs
  • examples
  • img
  • src
  • tests
    Good: Test files detected (tests).
  • website
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • babel.config.mjs
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    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.
  • eslint.config.mjs
    Good: Linter or formatter configured (eslint.config.mjs).
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • rollup.config.mjs
  • tsconfig.json
  • vitest.config.mts