ianlkl11234s/mini-taiwan-pulse

0

/ 100

Documentation81
Engineering71
Health73
TypeScript316MIT1d ago
Grade a repo

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

Documentation

81

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.

README12pt90

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

71

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.

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.

Reproducibility6pt80

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

CI/CD14pt85

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

Tests18pt100

Test files detected (src/components/featureInfo/__tests__).

Project health

73

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt65

Dependency manifest found (package.json).

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 24
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 24d 3h
    Median issue response
  • <1h
    Median PR merge time
  • 1
    Open issues
Repository files25 root entries
  • .agents
  • .claude
  • .codex
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • docs
  • public
  • scripts
  • src
    Good: Test files detected (src/components/featureInfo/__tests__).
  • .dockerignore
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • CLAUDE.md
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • index.html
  • LICENSE
    Good: Licensed under MIT.
  • nginx.conf
  • 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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • tsconfig.app.json
  • tsconfig.json
  • vite.config.ts
  • vitest.config.ts