cypress-io/cypress-documentation
Grade a repo

87

/ 100

GradeB

A well-known project done right. Strong docs and solid engineering throughout.

Top 18% of 5,156 graded repos

Cypress Documentation for the Cypress App, API, Cypress Cloud, UI Coverage and Cypress Accessibility.

Documentation93
Engineering78
Health100
TypeScript1,042MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

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

  3. 3
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  4. 4
    CI/CD14pt

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

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

93

Contributing guide5pt72

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

78

CI/CD14pt57

CI is configured (.github/workflows/create-pr-develop-to-master.yml).

Tests18pt80

Test files detected (plugins/cypressRemarkPlugins/src/copyTsToJs/transformEsmToCjs.spec.ts).

Reproducibility6pt80

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

Linting and formatting5pt100

Linter or formatter configured (.prettierrc).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

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)
  • 1,060
    Forks
  • 0
    Releases

Community

  • 62% - Fair
    Community health
  • -
    authors own >50% of commits
  • 1,042
    Watchers

Responsiveness

  • 6d 23h
    Median issue response
  • <1h
    Median PR merge time
  • 59
    Open issues
Repository files30 root entries
  • .circleci
  • .github
    Good: CI is configured (.github/workflows/create-pr-develop-to-master.yml).
    Good: Issue or PR templates present.
  • .husky
  • cypress
  • docs
  • patches
  • plugins
    Good: Test files detected (plugins/cypressRemarkPlugins/src/copyTsToJs/transformEsmToCjs.spec.ts).
  • scripts
  • src
  • static
  • .gitignore
    Good: .gitignore present.
  • .node-version
    Good: Environment pinned via .node-version.
  • .prettierignore
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • .textlintrc
  • AGENTS_REFERENCE.md
  • AGENTS.md
  • babel.config.js
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    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.
  • cypress.config.ts
  • docusaurus.config.js
  • LICENSE.md
    Good: Licensed under MIT.
  • netlify.toml
  • 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.
    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.
  • sidebars.js
  • tailwind.config.js
  • tsconfig.json
  • vercel.json
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/cypress-io/cypress-documentation)](https://www.repo-grade.com/report/cypress-io/cypress-documentation)

More graded TypeScript repos