microsoft/vscodeNew scan
91/ 100 · A

A landmark open source project with strong engineering quality.

Visual Studio Code

TypeScript186,346 starsMITupdated 1d ago
DocumentationREADME, setup, examples, license
80
EngineeringTests, CI, linting, lockfiles
100
Project healthDescription, activity, stars, deps
89

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
    README
    DocumentationIssue

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

Detailed breakdown

Documentation

80
  • README65
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • 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.
    • No .env.example found (−10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide72
    • 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 has no code examples (−5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Code of conduct present.

Engineering

100
  • Tests100
    • Test files detected (.eslint-plugin-local/tests).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/api-proposal-version-check.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.
  • Linting and formatting100
    • Linter or formatter configured (.editorconfig).
  • Reproducibility100
    • Lockfile present (package-lock.json). Installs are reproducible.
    • Environment pinned via .devcontainer/Dockerfile.
    • Dependabot covers 2 ecosystems (github-actions, devcontainers). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

89
  • Dependency manifest65
    • 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 links back to the repository.
    • 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 metadata100
    • Repository has a description.
    • Primary language detected: TypeScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 186,346 stars.
  • Housekeeping100
    • .gitignore present.
    • A .env file exists in a test directory (extensions/copilot/test/simulation/fixtures/multiFileEdit/issue-9647/.env). This is a test fixture, not a committed secret.
Repository files41 root entries
  • .agents
  • .config
  • .devcontainer
    Good: Environment pinned via .devcontainer/Dockerfile.
  • .eslint-plugin-local
    Good: Test files detected (.eslint-plugin-local/tests).
  • .github
    Good: CI is configured (.github/workflows/api-proposal-version-check.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, devcontainers). Dependencies stay current.
    Good: Issue or PR templates present.
    Good: .gitignore present.
  • .vscode
  • build
  • cli
  • extensions
    Good: Code of conduct present.
  • remote
  • resources
  • scripts
  • src
  • test
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslint-allowed-javascript-files
  • .eslint-ignore
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
  • .lsifrc.json
  • .mailmap
  • .mention-bot
  • .npmrc
  • .nvmrc
  • .vscode-test.js
  • AGENTS.md
  • cglicenses.json
  • cgmanifest.json
  • CodeQL.yml
  • 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 (e.g. npm run lint, ruff check .).
    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.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • eslint.config.js
  • gulpfile.mjs
  • LICENSE.txt
    Good: Licensed under MIT.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • product.json
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: 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.
  • SECURITY.md
    Good: Security policy present.
  • ThirdPartyNotices.txt
  • tsfmt.json