microsoft/rushstackNew scan
81/ 100 · B

Good community traction and solid fundamentals. Nearly in the top tier.

Monorepo for tools developed by the Rush Stack community

TypeScript6,473 starsOtherupdated 4d ago
DocumentationREADME, setup, examples, license
87
EngineeringTests, CI, linting, lockfiles
74
Project healthDescription, activity, stars, deps
86

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

87
  • README85
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • 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 Other.
  • Contributing guide70
    • CONTRIBUTING guide or docs directory present.
    • 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

74
  • Tests60
    • Test files detected (apps/api-documenter/src/markdown/test).
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/ci.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.
  • Linting and formatting60
    • Linter or formatter configured (.prettierrc.js).
  • Reproducibility80
    • Lockfile present (build-tests/rush-redis-cobuild-plugin-integration-test/sandbox/repo/common/config/rush/pnpm-lock.yaml). Installs are reproducible.
    • Environment pinned via build-tests/rush-amazon-s3-build-cache-plugin-integration-test/docker-compose.yml.
    • 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

86
  • Dependency manifest100
    • Dependency manifest found (apps/api-documenter/package.json).
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: TypeScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 6,473 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (build-tests/api-extractor-test-04/beta-consumer/node_modules/api-extractor-test-04) (−40 pts).Remove them and add to .gitignore.
Repository files27 root entries
  • .cursor
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Issue or PR templates present.
  • .trae
  • .vscode
  • apps
    Good: CONTRIBUTING guide or docs directory present.
    Good: Test files detected (apps/api-documenter/src/markdown/test).
    Good: Dependency manifest found (apps/api-documenter/package.json).
  • build-tests
    Good: Lockfile present (build-tests/rush-redis-cobuild-plugin-integration-test/sandbox/repo/common/config/rush/pnpm-lock.yaml). Installs are reproducible.
    Good: Environment pinned via build-tests/rush-amazon-s3-build-cache-plugin-integration-test/docker-compose.yml.
    Warning: Build artifacts or local files may be committed (build-tests/api-extractor-test-04/beta-consumer/node_modules/api-extractor-test-04) (−40 pts).Fix: Remove them and add to .gitignore.
  • build-tests-samples
  • build-tests-subspace
  • common
  • eslint
  • heft-plugins
  • libraries
  • repo-scripts
  • rigs
  • rush-plugins
  • skills
  • vscode-extensions
  • webpack
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc.js
    Good: Linter or formatter configured (.prettierrc.js).
  • LICENSE
    Good: Licensed under Other.
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Info: 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.
  • rush.json
  • SECURITY.md
    Good: Security policy present.