87/ 100 ยท B

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

The zero configuration build tool for the web. ๐Ÿ“ฆ๐Ÿš€

JavaScript44,031 starsMITupdated 9d ago
DocumentationREADME, setup, examples, license
78
EngineeringTests, CI, linting, lockfiles
94
Project healthDescription, activity, stars, deps
85

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
    DocumentationInfo

    Show a quick-start snippet so contributors can see what using your project looks like.

Detailed breakdown

Documentation

78
  • 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 instructions45
    • README documents how to install the project.
    • No run or usage instructions found (โˆ’45 pts).Add a section showing how to start or use 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 guide95
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • 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 explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Code of conduct present.

Engineering

94
  • Tests100
    • Test files detected (.mocharc.json).
  • CI/CD100

    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 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.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting75
    • Linter or formatter configured (.editorconfig).
    • Lint script wired into package.json.
  • Reproducibility82
    • Lockfile present (Cargo.lock). 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.
    • Dependabot configured for devcontainers.
    • Dependabot only covers one ecosystem (+12 pts; covering 2+ earns +20 pts).Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.
  • 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

85
  • Dependency manifest85
    • Dependency manifest found (Cargo.toml).
    • package.json has a description field.
    • 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.
  • Repository metadata85
    • Repository has a description.
    • Primary language detected: JavaScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 44,031 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (packages/core/core/test/fixtures/local-plugin-config-pkg/node_modules/parcel-config-local) (โˆ’40 pts).Remove them and add to .gitignore.
Repository files40 root entries
  • .cargo
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot configured for devcontainers.
    Good: Issue or PR templates present.
  • .husky
  • .vscode
  • .yarn
  • crates
  • docs
  • flow-libs
  • flow-typed
  • packages
    Warning: Build artifacts or local files may be committed (packages/core/core/test/fixtures/local-plugin-config-pkg/node_modules/parcel-config-local) (โˆ’40 pts).Fix: Remove them and add to .gitignore.
  • patches
  • scripts
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslintignore
  • .eslintrc.json
  • .flowconfig
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .mocharc.json
    Good: Test files detected (.mocharc.json).
  • .prettierignore
  • .prettierrc
  • .proxyrc.js
  • .yarnrc.yml
  • babel.config.json
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    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 .).
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • gulpfile.js
  • lerna.json
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    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.
    Warning: No run or usage instructions found (โˆ’45 pts).Fix: Add a section showing how to start or use the project.
  • rust-toolchain
  • rustfmt.toml
  • verdaccio.yml
  • verdaccioPublish.js
  • yarn.lock