foo-software/lighthouse-check-action

0

/ 100

Documentation65
Engineering87
Health94
TypeScript508MIT1d ago
Grade a repo

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

GitHub Action for running @GoogleChromeLabs Lighthouse audits with all the bells and whistles 🔔 Multiple audits, Slack notifications, and more!

Documentation

65

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

Contributing guide5pt77

CONTRIBUTING guide found.

README12pt90

README is present.

License6pt100

Licensed under MIT.

Engineering

87

CI/CD14pt57

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

Reproducibility6pt92

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

Tests18pt100

Test files detected (dist/test).

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.json).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 22
    Forks
  • 41
    Releaseslatest 6y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 508
    Watchers

Responsiveness

  • 15h
    Median issue response
  • 1h
    Median PR merge time
  • 5
    Open issues
Repository files17 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Issue or PR templates present.
  • dist
    Good: Test files detected (dist/test).
  • node_modules
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: Code of conduct present.
    Good: Environment pinned via node_modules/@foo-software/lighthouse-check/Dockerfile.
    Good: Dependabot is configured. Dependencies update automatically.
    Good: Security policy present.
    Issue: Build artifacts or local files may be committed (node_modules/.bin) (−40 pts).Fix: Remove them and add to .gitignore.
  • src
  • .eslintrc.json
    Good: Linter or formatter configured (.eslintrc.json).
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc
  • action.yml
  • jest.config.js
  • 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.
    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.
    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.
  • tsconfig.json
  • tsconfig.release.json
  • vercel.json