laurengarcia/url-metadata

0

/ 100

Documentation70
Engineering59
Health97
JavaScript171MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

npm module: Fetch a url & scrape the metadata from its HTML with Node.js or the browser.

Documentation

70

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.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

59

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit package-lock.json, pnpm-lock.yaml, yarn.lock, or bun.lock so Node installs are repeatable.

Tests18pt100

Test files detected (test).

Linting and formatting5pt100

Linter or formatter configured (lint script in package.json).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

97

Dependency manifest6pt90

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 2 / 4
    Commits (30d / 90d)
  • 43
    Forks
  • 0
    Releases

Community

  • 57% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 171
    Watchers

Responsiveness

  • 75d 6h
    Median issue response
  • 4d 21h
    Median PR merge time
  • 1
    Open issues
Repository files17 root entries
  • .github
    Good: Issue or PR templates present.
  • .husky
  • example-nextjs
  • example-typescript
  • example-vite
  • lib
  • test
    Good: Test files detected (test).
  • .gitignore
    Good: .gitignore present.
  • browser.js
  • CHANGELOG.md
  • index.d.ts
  • index.js
  • LICENSE
    Good: Licensed under MIT.
  • main.js
  • 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.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • ROADMAP.md