swc-project/swc-playground

0

/ 100

Documentation36
Engineering30
Health86
TypeScript136MIT1d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

The SWC playground.

Documentation

36

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.

README12pt45

README is present.

License6pt100

Licensed under MIT.

Engineering

30

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

CI/CD14pt40

CI is configured (.github/workflows/check-update.yml).

Reproducibility6pt70

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

86

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt75

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)
  • 33
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 2h
    Median issue response
  • 21h
    Median PR merge time
  • 2
    Open issues
Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/check-update.yml).
  • .vscode
  • public
  • scripts
  • src
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env
    Issue: Build artifacts or local files may be committed (.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .eslintrc.json
  • .gitignore
    Good: .gitignore present.
  • dprint.json
  • env.d.ts
  • LICENSE
    Good: Licensed under MIT.
  • next-env.d.ts
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
  • tsconfig.json
  • vercel.json