w3c/webref

0

/ 100

Documentation39
Engineering70
Health92
JavaScript446MIT2d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

Machine-readable references of terms defined in web browser specifications

Documentation

39

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt55

README is present.

License6pt100

Licensed under MIT.

Engineering

70

Linting and formatting5pt0

No linter or formatter found.

→ Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.

CI/CD14pt40

CI is configured (.github/workflows/test.yml).

Reproducibility6pt82

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

Tests18pt100

Test files detected (test).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

92

Dependency manifest6pt75

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Dependabot is configured. Dependencies update automatically.
    Good: Issue or PR templates present.
  • ed
  • packages
  • packages-auto
  • test
    Good: Test files detected (test).
  • tools
  • tr
  • .gitignore
    Good: .gitignore present.
  • index.html
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    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.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • w3c.json