twbs/bootstrapNew scan
92/ 100 · A

A landmark open source project with strong engineering quality.

The most popular HTML, CSS, and JavaScript framework for developing responsive, mobile first projects on the web.

MDX174,322 starsMITupdated 2d ago
DocumentationREADME, setup, examples, license
93
EngineeringTests, CI, linting, lockfiles
89
Project healthDescription, activity, stars, deps
97

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 `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

93
  • 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 guide75
    • CONTRIBUTING guide or docs directory present.
    • Code of conduct present.

Engineering

89
  • Tests100
    • Test files detected (js/tests).
  • CI/CD72

    Not applicable?

    • CI is configured (.github/workflows/lint.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 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 formatting75
    • Linter or formatter configured (.editorconfig).
    • Lint script wired into package.json.
  • Reproducibility100
    • Lockfile present (package-lock.json). Installs are reproducible.
    • Environment pinned via .nvmrc.
    • Dependabot covers 2 ecosystems (github-actions, npm). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

97
  • Dependency manifest90
    • Dependency manifest found (composer.json).
    • package.json has a description field.
    • package.json links back to the repository.
    • 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: MDX.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 174,322 stars.
  • Housekeeping100
    • .gitignore present.
Repository files31 root entries
  • .github
    Good: CONTRIBUTING guide or docs directory present.
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • .vscode
  • build
  • dist
  • js
    Good: Test files detected (js/tests).
  • nuget
  • scss
  • site
  • .babelrc.js
  • .browserslistrc
  • .bundlewatch.config.json
  • .cspell.json
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslintignore
  • .eslintrc.json
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .ncurc.json
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • .prettierignore
  • .stylelintignore
  • .stylelintrc.json
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • composer.json
    Good: Dependency manifest found (composer.json).
  • config.yml
  • LICENSE
    Good: Licensed under MIT.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.js
  • 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.
  • SECURITY.md
    Good: Security policy present.