cypress-io/cypressNew scan
89/ 100 · B

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

Fast, easy and reliable testing for anything that runs in a browser.

TypeScript49,880 starsMITupdated 3d ago
DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
83
Project healthDescription, activity, stars, deps
94

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringWarning

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    CI/CD
    EngineeringInfo

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

Detailed breakdown

Documentation

97
  • 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 guide100
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

83
  • Tests100
    • Test files detected (cli/test).
  • CI/CD57

    Not applicable?

    • CI is configured (.github/workflows/auto_approve_low_risk.yml).
    • The CI workflow does not appear to run any tests (−28 pts).Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
    • 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 formatting75
    • Linter or formatter configured (.eslintrc.js).
    • Lint script wired into package.json.
  • Reproducibility80
    • Lockfile present (yarn.lock). Installs are reproducible.
    • Environment pinned via .cursor/Dockerfile.
    • 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

94
  • 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).
    • 49,880 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (packages/server/test/support/fixtures/cloud/environment/all-tracked-dependencies/node_modules/bar) (−40 pts).Remove them and add to .gitignore.
Repository files49 root entries
  • __snapshots__
  • .circleci
    Good: .gitignore present.
  • .cursor
    Good: Environment pinned via .cursor/Dockerfile.
  • .github
    Good: CI is configured (.github/workflows/auto_approve_low_risk.yml).
    Good: Issue or PR templates present.
  • .husky
  • .vscode
  • assets
  • cli
    Good: Test files detected (cli/test).
  • docs
  • guides
  • npm
  • packages
    Warning: Build artifacts or local files may be committed (packages/server/test/support/fixtures/cloud/environment/all-tracked-dependencies/node_modules/bar) (−40 pts).Fix: Remove them and add to .gitignore.
  • patches
  • scripts
  • system-tests
  • tooling
  • .eslintrc.js
    Good: Linter or formatter configured (.eslintrc.js).
  • .gitattributes
  • .gitignore
  • .node-version
  • .npmrc
  • .nvmrc
  • .percy.yml
  • .prettierignore
  • .releaserc.js
  • .yarnclean
  • AGENTS.md
  • apollo.config.js
  • autobarrel.json
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • docker-compose.yml
  • electron-builder.json
  • gulpfile.js
  • jsconfig.json
  • knip.json
  • lerna.json
  • LICENSE
    Good: Licensed under MIT.
  • mocha-reporter-config.json
  • 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.
    Good: README documents how to run the project.
  • renovate.json
  • ROADMAP.md
  • SECURITY.md
    Good: Security policy present.
  • vitest.config.ts
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.